LuxaDocs — Frequently Asked Questions

Is LuxaDocs really free?

Yes. LuxaDocs is 100% free with no Pro version, no premium add-ons, and no feature limitations.

Where does my documentation page live?

By default at yoursite.com/docs/. Change it under LuxaDocs → Settings → General → LuxaDocs Root Slug — the Documentation page’s own URL automatically moves to match whatever you set.

Does it support translations?

Yes. LuxaDocs is translation-ready with the text domain luxadocs.

What WordPress/PHP versions does it need?

WordPress 5.8+ and PHP 7.4+.

What’s the difference between Categories and Tags?

Categories are the primary structure — they drive the URL hierarchy (/docs/category-slug/doc-slug/), the category navigation shown in the sidebar and on the Documentation page, and can be nested (parent/child). Tags are flat, free-form labels for cross-cutting topics that don’t fit the category hierarchy — they don’t affect URLs or navigation the same way.

Can a doc belong to more than one category?

Yes — assign as many categories as you like in the doc editor sidebar.

Why doesn’t my doc appear on the Documentation page?

Check that:

• It’s Published, not a Draft.
• Order Docs By / Order (Settings → Layout → Documentation Page → Order By) hasn’t pushed it past the Number Of Docs shown per page.
• If you’re filtering with [luxadocs_docs category="..."] somewhere, make sure the category attribute matches the doc’s actual category slug, not its display name.

How do I show a shortcode as literal text instead of running it?

Wrap it in double brackets: [[luxadocs_docs]] displays as [luxadocs_docs] instead of executing — the standard WordPress shortcode-escaping syntax. This works for any shortcode, not just LuxaDocs’.

A shortcode I added behaves differently for a logged-in admin vs. a logged-out visitor — is that a bug?

Usually not a LuxaDocs bug — it depends on the shortcode. Some shortcodes (a login form, a “member only” block, etc.) are designed to check whether the visitor is logged in and show different content on purpose. If you’re testing a LuxaDocs shortcode ([luxadocs_docs], [luxadocs_search], [luxadocs_categories]) and see a genuine difference by login state, that would be worth reporting — but LuxaDocs’ own shortcodes render the same output regardless of who’s viewing them.

The TOC isn’t showing at all

Check Settings → Layout → Single Doc → TOC → Table of Contents is on, and that your doc actually has headings at the levels set in TOC Supported Heading Tag (H2/H3 by default — H1 is never picked up, since that’s reserved for the doc title itself).

My TOC links don’t scroll to the right spot

Increase Anchor Scroll Offset (Settings → Layout → Single Doc → TOC) if a sticky theme header is covering the top of each section after the jump.

Clicking a TOC link does nothing on some sections but works on others

Make sure you’re on the latest LuxaDocs version — a bug in versions before 1.5.21 caused exactly this for headings whose text started with a number (e.g. “1. Introduction”), which is a common pattern in documentation. Updating resolves it; see the Changelog.

Should I use “Plugin Template” or “Theme Template” mode for single docs?

Plugin Template (default) is the safest choice — it looks the same on any theme, using LuxaDocs’ own layout and width. Theme Template hands the doc body to your active theme’s real single-post template instead, so your theme’s own fonts, container width, and (if it has one) sticky sidebar apply automatically with zero setup — worth trying if you want the doc to visually match the rest of your site more closely than the Plugin Template mode does. If your theme’s content column is narrow, pair Theme Template with TOC Position → In Content rather than Sidebar.

My theme’s own typography (headings, links, paragraph spacing) doesn’t apply inside my docs

Set Content Wrapper Extra Class (Settings → General) to the CSS class your theme’s typography styles actually target — commonly entry-content for most themes, or prose for Tailwind-based ones. Check your theme’s documentation or inspect a normal post/page in your browser’s dev tools to find the right class name.

Can I override the templates myself?

Yes. Copy archive-luxadocs_doc.php from the plugin’s /templates folder into a luxadocs folder inside your active theme to override the Documentation/category archive layout. Single docs work differently — since they’re injected via the_content() in “Theme Template” mode (or use their own dedicated template in “Plugin Template” mode), style them with CSS instead (everything is scoped under .luxadocs-single).

The colors I set in Customize aren’t showing everywhere

Make sure you’re on the latest version — versions before 1.5.19 didn’t apply Customize colors on the built-in Documentation page itself (only on individual doc pages and category archives). Updating resolves it.

I turned on “Enable Email Feedback” but I’m not getting emails

Double-check Send Feedback To has a valid address, and that your site can actually send email at all (many hosts block PHP’s default mail() function — an SMTP plugin like Luxa Mail SMTP usually fixes this if other WordPress emails, like password resets, also aren’t arriving). Also confirm you’re on 1.5.20 or later — this feature didn’t send anything at all in earlier versions.

This same Send Feedback To address is also what the “Contact support” link (in the Documentation page / category archive footer) mails — on 1.5.21 and earlier it always used your site’s admin email regardless of this setting.

Where do doc attachments come from?

From the Attachments box on the doc edit screen (enable it first under Settings → Layout → Single Doc → Attachments) — click Add Attachment to pick files from your Media Library.

I changed the Root Slug and now some links 404

If you have the URL hardcoded somewhere else on your site (a menu item, a hardcoded link in a widget, an external backlink), those won’t update automatically — only LuxaDocs’ own generated links (category/doc/Documentation page URLs) follow the new setting. Update any hardcoded links manually, and double-check Settings → Permalinks doesn’t need a manual re-save if something still looks off.

How do I completely remove all LuxaDocs data?

By default, deleting the plugin keeps your Docs, Categories, Tags, and settings (in case you reinstall later). For a full clean removal:

1. Add this line to your site’s wp-config.php, above the /* That's all, stop editing! */ line:

   define( 'LUXADOCS_REMOVE_ALL_DATA', true );

2. Go to Plugins, deactivate LuxaDocs, then click Delete.
3. This permanently removes all Docs, Doc Categories, Doc Tags, and every LuxaDocs setting. It’s irreversible — back up your database first if you’re not sure.
4. Remove the line from wp-config.php afterward (optional, but tidy).

Does deactivating (not deleting) the plugin delete anything?

No. Deactivating only stops LuxaDocs from running — your docs, categories, tags, and settings are all preserved untouched, so you can safely reactivate at any time.

Still stuck? See the User Guide for the full settings reference, or the Installation guide for setup steps.