cartpauj

MVP Docs adds a simple documentation system to your WordPress site. It creates a Docs custom post type with categories, a clean archive page, and a markdown import tool — nothing more.
Why MVP Docs?
AI tools like Claude and ChatGPT are excellent at generating documentation in Markdown format. MVP Docs was built to take advantage of that — paste your AI-generated <code>.md</code> files straight into WordPress with a single click. No copy-pasting HTML, no reformatting, no fussing with blocks. Just import and publish.
Beyond the AI workflow, most documentation plugins are overbuilt. They add custom page builders, proprietary editors, dozens of database tables, and megabytes of JavaScript. MVP Docs takes the opposite approach:
<ul>
<li>Uses the native WordPress block editor</li>
<li>Works with any theme (block themes and classic themes)</li>
<li>Stores content as standard WordPress posts</li>
<li>Loads zero scripts or styles outside of doc pages</li>
<li>No lock-in — your content is just posts and taxonomies</li>
<li>No external dependencies — everything ships with the plugin</li>
</ul>
Features
<ul>
<li>Docs post type with archive at <code>/docs/</code></li>
<li>Doc Categories for organizing content</li>
<li>Search — AJAX-powered typeahead dropdown on the archive and category pages, with a dedicated search results page at <code>/docs/search/</code></li>
<li>Markdown import — upload a <code>.md</code> file and it converts to native Gutenberg blocks (tables, code blocks, lists, and all GFM features)</li>
<li>Import / Export — export docs, categories, and settings as a JSON file, or include referenced images in a zip bundle; import on another site</li>
<li>Archive page — docs grouped by category in a card grid</li>
<li>Category archives — full list of docs in a category with search bar</li>
<li>Search results page — dedicated page with breadcrumbs and themed card layout</li>
<li>Breadcrumbs on single doc pages</li>
<li>Settings — archive layout (columns, border radius, docs per category), colors, page titles, sort order, custom slugs, category ordering via drag-and-drop</li>
<li>Block theme support — registers proper block templates for single docs, archives, category pages, and search</li>
<li>Classic theme support — falls back to PHP templates with <code>get_header()</code>/<code>get_footer()</code></li>
<li>WP-CLI — full command-line coverage so an AI agent or shell script can configure and populate a docs site without ever opening wp-admin</li>
</ul>
Markdown Import — Built for AI-Generated Docs
AI tools produce clean, well-structured Markdown. MVP Docs lets you import those <code>.md</code> files directly into the block editor with one click. The sidebar includes an “Import from Markdown” button — upload a file and it gets parsed client-side with full GitHub Flavored Markdown support (via marked.js), then converted into native Gutenberg blocks. The first <code># Heading</code> becomes the post title automatically.
Use your favorite AI to generate docs, how-to guides, or knowledge base articles in Markdown, then import them into WordPress without any reformatting.
Supported: headings, bold, italic, links, images, tables, fenced code blocks with syntax hints, task lists, strikethrough, blockquotes, horizontal rules, ordered and unordered lists.
Import / Export
Go to Docs > Settings > Import / Export to:
<ul>
<li>Export docs, categories, and/or settings as a single JSON file</li>
<li>Import a previously exported file to restore or migrate content between sites</li>
</ul>
Existing docs with the same title are skipped during import to avoid duplicates. Categories are created automatically if they don’t exist.
WP-CLI
Every admin action has a command-line equivalent, so a docs site can be stood up and populated entirely from a shell script or AI agent. Run <code>wp mvp-docs <command> --help</code> for full details on any command below.
Content
<pre><code>wp mvp-docs import-md <file>
</code></pre>
Import a Markdown file as a doc. Output is byte-identical to the sidebar Markdown importer — same blocks, same title extraction from the first <code>#</code> heading.
<pre><code>wp mvp-docs import-raw <file>
</code></pre>
Import a raw HTML file as a doc. Block-commented HTML is preserved as-is; plain HTML renders as a Classic block in the editor.
Both import commands accept: 
* <code>--title=<text></code> — override the extracted title 
* <code>--slug=<slug></code> — explicit post slug 
* <code>--excerpt=<text></code> — short description shown on category/search pages 
* <code>--category=<slug></code> — assign to this category (created if missing) 
* <code>--sort-order=<n></code> — in-category sort priority (lower appears first) 
* <code>--status=<publish|draft|private></code> — post status (default: publish) 
* <code>--dry-run</code> — print the generated markup instead of creating a post
Backup and migration
<pre><code>wp mvp-docs export [--docs] [--settings] [--with-images] [--output=<file>] [--pretty]
</code></pre>
Dump docs, categories, settings, and category order to a single JSON bundle. Omitting <code>--docs</code> and <code>--settings</code> exports everything. Pipe to stdout or write to a file. Pass <code>--with-images</code> to bundle referenced images into a zip alongside <code>export.json</code> (requires <code>--output</code>).
<pre><code>wp mvp-docs import <file>
</code></pre>
Restore a previously exported file. Auto-detects <code>.json</code> and <code>.zip</code> bundles; for zips, referenced images are sideloaded into the media library and content URLs are rewritten. Docs are deduplicated by title, so running the same import twice is safe.
Structure
<pre><code>wp mvp-docs reorder-categories <slug-or-id>...
</code></pre>
Set the display order of categories. Accepts term IDs or slugs.
Settings
<pre><code>wp mvp-docs settings list [--format=table|json|yaml|csv]
</code></pre>
Show every setting with its current value, description, and allowed form — self-documenting so you never have to read the source to discover what’s configurable.
<pre><code>wp mvp-docs settings get <key>
</code></pre>
Print a single setting’s value.
<pre><code>wp mvp-docs settings set <key=value>...
</code></pre>
Update one or more settings. Values run through the same sanitizer as the admin UI; if a value is rejected (e.g. <code>columns=7</code> when the allowed range is 1–4), a warning names the allowed form and shows the actual saved value. Changing <code>docs_slug</code> or <code>category_slug</code> auto-flushes rewrite rules.
Quick start for AI agents
<pre><code>wp plugin activate mvp-docs
wp mvp-docs settings set docs_slug=kb archive_title="Knowledge Base"
wp term create mvpd_category "Getting Started" --slug=getting-started
wp mvp-docs reorder-categories getting-started
wp mvp-docs import-md ./intro.md --category=getting-started --sort-order=1
wp mvp-docs export --output=backup.json
</code></pre>

MVP Docs

A lightweight documentation plugin for WordPress. AI-friendly markdown import, native editor, no bloat.

Alex Hedström

DevDocs is a WordPress plugin for publishing clear, organised developer documentation on your site. It gives you a documentation page with a collapsible sidebar for browsing sections and a main content area for reading articles.
Key Features
<ul>
<li>Documentation articles and updates — Publish help articles and version updates in one place.</li>
<li>Organised sections — Group your content into folders and sub-folders for easier browsing.</li>
<li>Sidebar navigation — Visitors can move between the overview, sections, articles, and changelog from one menu.</li>
<li>Instant search — Quickly find articles from the sidebar as you type.</li>
<li>Mobile-friendly layout — The documentation view works cleanly on smaller screens.</li>
<li>Welcome screen — Show an introduction, helpful topic cards, and your latest update before a visitor opens an article.</li>
<li>Changelog timeline — Display product updates in a clear version-by-version timeline.</li>
<li>Custom colours — Match the documentation area to your brand with built-in colour settings.</li>
<li>Full-page layout option — Display your documentation in a distraction-free full-browser view.</li>
<li>Article guidance — Help readers stay oriented with breadcrumbs, last updated dates, and previous/next article links.</li>
<li>Manual ordering — Choose the order in which articles appear inside each section.</li>
<li>Translation-ready — Includes English language files and a translation template for other languages.</li>
</ul>
<h3>Usage</h3>
<h4>Documents</h4>
Add your documentation articles in DevDocs and assign them to one or more Topics so they appear in the right place in the sidebar. Use Order if you want to control which articles appear first.
<h4>Topics</h4>
Use Topics to build your sidebar structure. You can create main sections and place sub-sections inside them, then use Order to control how they are listed.
<h4>Changelog</h4>
Each changelog entry supports: 
* A Version Number and Release Date. 
* A summary description. 
* Update items grouped as Added, Changed, Fixed, Removed, Deprecated, or Security.
<h4>Settings</h4>
Navigate to DevDocs → Settings to configure:
<ul>
<li>Documentation Page — The WordPress page that renders the docs layout.</li>
<li>Documentation Name — Label shown in the sidebar header.</li>
<li>Welcome Heading / Message — Text displayed on the overview screen.</li>
<li>Show Topic Cards — Toggle topic card grid on the welcome screen.</li>
<li>Show Latest Update — Toggle the latest changelog snippet on the welcome screen.</li>
<li>Full Page Mode — Expand the documentation into a full-browser layout.</li>
<li>Color Scheme — Choose the colours used across the documentation area.</li>
</ul>

DevDocs

Developer software documentation with folder-based navigation, changelog tracking, and customizable color schemes.

MVP Docs vs DevDocs