LuxaDocs — Installation
LuxaDocs is 100% free — no Pro version, no add-ons, no feature limitations. This guide gets you from “just installed” to “first doc published” in a few minutes.
Requirements
| Minimum | |
|---|---|
| WordPress | 5.8 |
| PHP | 7.4 |
1. Install the plugin
Option A — From the WordPress Plugin Directory
- In your WordPress admin, go to Plugins → Add New.
- Search for LuxaDocs.
- Click Install Now, then Activate.
Option B — Upload the ZIP manually
- Go to Plugins → Add New → Upload Plugin.
- Choose the
luxadocs.zipfile and click Install Now. - Click Activate Plugin.
Option C — Upload via FTP/SFTP
- Unzip the plugin package.
- Upload the
luxadocsfolder to/wp-content/plugins/. - In WordPress admin, go to Plugins, find LuxaDocs, and click Activate.
2. What happens automatically on activation
You don’t need to configure anything to get a working documentation section. On activation, LuxaDocs:
- Registers the Docs post type (with Categories and Tags).
- Creates a “Documentation” page and sets it live at
yoursite.com/docs/— this page holds the built-in doc listing and is managed automatically (don’t delete or manually edit its content; see the FAQ for why). - Flushes permalinks so
/docs/...URLs work right away.
Visit yoursite.com/docs/ after activating — you’ll see an empty “Documentation” listing, ready for your first doc.
3. Create your first category
Categories group your docs and power the category navigation shown on the Documentation page and inside each doc’s sidebar.
- Go to LuxaDocs → Categories.
- Enter a Name (e.g. “Getting Started”) and click Add New Category.
- Repeat for as many categories as you need. Categories can be nested (parent/child) if your knowledge base needs sub-sections.
4. Write your first doc
- Go to LuxaDocs → Add New.
- Give it a title and write the content in the normal WordPress editor.
- In the right sidebar, assign it to a Category (and optionally Tags).
- Use Heading 2 / Heading 3 blocks for your sections — LuxaDocs automatically turns these into a clickable Table of Contents.
- Click Publish.
Your doc is now live at yoursite.com/docs/your-doc-slug/, and appears automatically in the Documentation page listing.
5. Configure permalinks and layout (optional)
Everything works out of the box with sensible defaults. If you want to customize URLs, colors, or which page elements show, go to LuxaDocs → Settings — see the separate User Guide for a full walkthrough of every option.
At minimum, it’s worth a quick look at:
- Settings → General → LuxaDocs Root Slug — change
docsto something else (e.g.help,kb) if you’d prefer a different URL prefix. - Settings → Customize — set your Accent, Background, and Text colors to match your site.
6. Add doc-related shortcodes anywhere (optional)
LuxaDocs also gives you shortcodes to drop a doc listing, search box, or category list into any other page or post — see the User Guide’s Shortcodes section for the full list and examples.
Uninstalling
Deactivating the plugin (Plugins → Deactivate) does not delete anything — your docs, categories, tags, and settings are all preserved, so you can reactivate safely at any time.
If you delete the plugin from Plugins → Delete, your content is still kept by default. If you want a completely clean removal (deleting all Docs, Categories, Tags, and settings), see the FAQ entry “How do I completely remove all LuxaDocs data?”.
Next steps
- Read the User Guide for a full walkthrough of every setting and shortcode.
- Check the FAQ for answers to common setup questions.
- See the Changelog for what’s new in the latest version.
Was this doc helpful?
Powered by LuxaDocs