LuxaDocs — User Guide

LuxaDocs adds three things to your site:

• Docs — a custom post type (like Posts, but dedicated to documentation). Write and manage them under LuxaDocs → All Docs / Add New, using the normal WordPress editor.
• Categories — group docs into sections (e.g. “Getting Started”, “API Reference”). Categories can be nested.
• Tags — free-form labels for cross-cutting topics, independent of category structure.

Everything else — the Documentation page, the single doc layout, search, the Table of Contents — is generated automatically from your docs and categories.

Creating a doc

Go to LuxaDocs → Add New. A doc works exactly like a WordPress Post:

• Title and content — write normally. Add a Featured Image if you want a thumbnail on the Documentation page grid.
• Category — assign one or more categories in the sidebar. A doc without a category still works, but won’t appear grouped under any category section.
• Tags — optional, free-form.
• Excerpt — shown as the card summary on the Documentation page listing if set.
• Attachments — see below.

Sections and the Table of Contents

Structure your doc’s content with Heading 2 and Heading 3 blocks (or H2–H6, depending on the “TOC Supported Heading Tag” setting — see §7). LuxaDocs automatically:

• Assigns each heading a unique, URL-safe anchor id.
• Builds a clickable Table of Contents from those headings.
• (Optional) Wraps each top-level H2 section with the signature “postmark” numbered marker.

If you’ve manually set a custom anchor on a heading (e.g. the block editor’s Advanced → HTML Anchor field), LuxaDocs respects it instead of generating its own.

Escaping a shortcode inside a doc

If you want to show a shortcode as literal text in your doc’s content (for example, documenting the shortcode itself) instead of having it run, wrap it in double brackets:

[luxadocs_docs]

This displays as [luxadocs_docs] on the page instead of executing it — the standard WordPress shortcode-escaping syntax.

Attachments

If Attachments is enabled (Settings → Layout → Single Doc → Attachments), an Attachments box appears on the doc edit screen (in the sidebar, alongside Category/Tags). Click Add Attachment to pick one or more files from the Media Library — they’re listed at the bottom of the doc for readers to download.

Reordering docs

Docs support the standard WordPress Menu Order field (in Quick Edit, or via a page-ordering plugin). Set Order Docs By → Menu Order (the default — see §6) to control the Documentation page and category listings by this order.

LuxaDocs automatically creates and maintains a page called “Documentation”, holding your built-in doc listing. You’ll find it under Pages in wp-admin, but you shouldn’t edit its content directly — it exists only to hold the [luxadocs_home] shortcode, and LuxaDocs manages its title and slug for you based on your settings.

This page shows:

• A live search box (if enabled).
• Your categories, each with its doc count and an “Explore More” link.
• A grid/list of your docs.

Its URL follows the LuxaDocs Root Slug setting (docs by default — see §5), and its title follows Documentation Page Title.

Each doc gets its own page, combining:

• Breadcrumb (Home → Category → Doc Title).
• Title, last-updated date, and estimated reading time.
• Table of Contents — either a sticky sidebar (3-column layout) or a collapsible block above the content (1-column layout), depending on TOC Position.
• The doc’s content, with postmark section markers (optional).
• Tags, if any.
• A Yes/No “Was this doc helpful?” feedback widget.
• Attachments, if any.
• Previous/Next doc navigation.
• Related Docs — other docs sharing a category.
• A category list.
• A “Powered by LuxaDocs” credit (on by default — see §7 to turn it off).

Every one of these is individually toggleable in Settings → Layout → Single Doc.

LuxaDocs → Settings → General

Changed your permalink settings? LuxaDocs flushes rewrite rules automatically when you save Settings, so new URLs work immediately — no need to visit Settings → Permalinks yourself.

LuxaDocs → Settings → Layout → Documentation Page

General

Search

Order By

LuxaDocs → Settings → Layout → Single Doc

General

TOC

Breadcrumb

Email Feedback

Attachments

Related Docs

LuxaDocs → Settings → Customize

These apply across the Documentation page, category/tag archives, and single docs.

Use these to place doc content anywhere outside the built-in Documentation page — a custom landing page, a sidebar widget area (via a Shortcode block/widget), or your own hand-built listing.

[luxadocs_docs] — a grid of docs

[luxadocs_docs]

[luxadocs_docs category="getting-started"]

[luxadocs_docs number="6" columns="2"]

[luxadocs_search] — a search box

[luxadocs_search]

No attributes — placeholder text, button label, and live-search behavior all follow Settings → Layout → Documentation Page → Search.

[luxadocs_categories] — a list of categories

[luxadocs_categories]

No attributes — lists every doc category with a link to its archive, and its doc count if Doc Count is enabled in Settings.

[luxadocs_home] also exists, but is internal — it’s what powers the auto-created Documentation page and isn’t meant to be added by hand.

Go to LuxaDocs → Settings → Import / Export.

• Export Settings — a read-only box showing your current settings as JSON. Select and copy it to back up your configuration or move it to another site.
• Import Settings — paste a previously exported JSON block into the text box and click Import to apply it.

This only affects Settings — it does not import or export your actual Docs/Categories/Tags content.

The Shortcodes tab next to Import/Export is a quick on-screen reference for the shortcodes covered in §9 above.

Questions not answered here? Check the FAQ, or see the Changelog for recent changes.