=== Karma Docs – Documentation & Knowledge Base ===
Contributors: karmadocs
Tags: documentation, knowledge base, docs, faq, help center
Requires at least: 6.6
Tested up to: 7.1
Requires PHP: 7.4
Stable tag: 1.0.0
License: GPLv2 or later
License URI: https://www.gnu.org/licenses/gpl-2.0.html

Build a beautiful help center: nested articles and categories, a drag & drop builder, instant search, table of contents, feedback and more.

== Description ==

Karma Docs turns WordPress into a fast, modern documentation site and knowledge base. Organise content visually, publish with the block editor and give readers instant answers.

= Drag & drop builder =

* Unlimited categories with unlimited nesting.
* Unlimited nested articles (articles inside articles, at any depth).
* Drag articles within or between categories at any level. Drag right to nest, left to move out.
* Reorder and nest categories.
* Keyboard friendly: move items with the arrow keys and indent/outdent with Tab.
* Select several items and move them in one go.
* Inline rename, quick add, duplicate, publish/unpublish and trash from the tree. Undo for every move.

= A help center readers love =

* Docs home, knowledge base home, category, article and search results templates.
* Works with block themes and classic themes. Override any template in your theme.
* Instant search with highlighted matches and a ⌘K / Ctrl K search palette.
* Collapsible sidebar navigation and a sticky table of contents with scroll spy.
* Breadcrumbs, previous/next links, related articles, reading time, last updated and print.
* "Was this helpful?" voting and a page-cache-safe view counter.
* Copy buttons on code blocks and click-to-copy heading links.
* Light/dark mode toggle without a flash on load.
* Pretty nested URLs (`/docs/{knowledge-base}/{parent}/{child}/`) and automatic 301 redirects when you move an article.

= Content blocks =

* Callout (info, tip, warning, danger, success).
* FAQ accordion with FAQPage structured data.
* Tabs, Steps and Code group blocks for technical docs.
* Docs Home, Docs Search and Knowledge Base blocks, plus matching shortcodes.
* Elementor widgets for Docs Home, Search and Knowledge Base.

= SEO & performance =

* TechArticle, BreadcrumbList and FAQPage JSON-LD.
* No jQuery on the frontend; assets only load on documentation pages.
* Translation ready and RTL compatible. Compatible with WPML and Polylang.

= Karma Docs Pro =

Pro (also available as Business and Agency plans for more sites) adds:

* Unlimited knowledge bases and moving content between them.
* Doc versions (v1 / v2 …) with a version switcher.
* AI answers ("Ask the docs") and an AI writing assistant using your own Anthropic, OpenAI or Google key.
* Members-only and role-based access control.
* Analytics: views, trends, top searches and searches with no results.
* Feedback inbox, email alerts and a weekly report.
* Contributors & approval workflow with a review queue.
* Floating help widget for every page of your site.
* PDF export of an article or a whole knowledge base.
* Slack and webhook notifications, Algolia search.
* Import/export and one-click migration from weDocs, BetterDocs and Echo Knowledge Base.
* Premium layouts, custom CSS and white label.

== Installation ==

1. Upload the plugin through Plugins → Add New → Upload Plugin, or install it from the plugin directory.
2. Activate it. You will land on the Karma Docs dashboard.
3. Click "Create sample knowledge base" or create your own, then open the Builder.
4. Your documentation lives at `yoursite.com/docs/`. You can change the slug in Karma Docs → Settings.

Pretty permalinks (Settings → Permalinks) are recommended. Plain permalinks are supported too.

== Frequently Asked Questions ==

= Does it work with my theme? =

Yes. Karma Docs ships its own templates and works with both block themes and classic themes. To customise a template, copy it from `wp-content/plugins/karma-docs/templates/` to `wp-content/themes/your-theme/karma-docs/`.

= Can I use the block editor for articles? =

Yes. Articles are edited in the block editor. A "Knowledge Base" panel lets you pick the knowledge base, category, parent article, icon and table of contents options.

= Can I have more than one knowledge base? =

The free version includes one knowledge base with unlimited categories and articles. Pro adds unlimited knowledge bases.

= Will moving an article break links? =

No. When an article moves to a new parent or category, its old URL redirects (301) to the new one.

= Does it slow down my site? =

Frontend assets are dependency-free and only load on documentation pages or where you place a docs block/shortcode.

= Is my data removed when I delete the plugin? =

Only if you choose so: enable "Delete all data when the plugin is uninstalled" in Karma Docs → Settings → Advanced. Otherwise your articles stay in the database.

== Screenshots ==

1. A beautiful docs home: knowledge bases, instant search and popular articles that match your brand.
2. The drag & drop builder: nest categories and articles, reorder with the mouse or keyboard, undo any change.
3. Articles with sidebar navigation, breadcrumbs, tabs, code groups and callouts.
4. Instant search (⌘K or /) with section-level results, highlighted matches and category filters.
5. The design studio: presets, colors, fonts, layouts and sidebar styles with a live preview.
6. Six sidebar styles: Classic, Lined, Boxed, Filled, Minimal and Accordion.
7. Light and dark mode on every screen size.
8. The help widget (Pro): search and open articles on any page of your site.

== Changelog ==

= 1.0.0 =
* Initial release.
