Description
Webxpart Documentation Hub adds a full documentation / knowledge base system to WordPress:
- Multiple documentations — run as many separate documentations as you like on one site (e.g. “User Guide”, “Developer API”), each with its own home, its own sidebar tree and its own URL space.
- Unlimited nesting — a documentation is simply a top-level doc; everything beneath it becomes its sections and articles, to any depth.
- Reader feedback — a “Was this page helpful?” prompt on every doc, with an optional comment when the answer is no.
- Insights — see your lowest-rated docs, your most-read docs, and the searches that returned nothing at all. That last list is your writing backlog.
- Access control — keep a documentation public, restrict it to logged-in users, or limit it to chosen roles. Restricted docs disappear from the sidebar, the search results and direct links.
- Live AJAX search — instant results as you type, scoped to docs only.
- Automatic table of contents — generated from your headings, with scroll-spy highlighting.
- Breadcrumbs & prev/next navigation — plus a collapsible documentation sidebar.
- Works with any theme — your theme renders the page; Webxpart Documentation Hub only fills the content area. All CSS is namespaced under a single wrapper class, so nothing leaks in or out. Nothing to configure to “make it fit.”
Two design modes
Under Webxpart Documentation Hub Settings Design mode you can choose how docs look:
- Self-contained (default) — docs get their own polished, fully scoped styling with automatic dark mode. Pixel-consistent on every theme.
- Inherit theme styles — docs adopt your active theme’s fonts, colours and content styling. Webxpart Documentation Hub adds layout only, and tints its UI from your theme’s own text colour, so the docs blend seamlessly into your site.
Why it doesn’t break your theme
Every style rule is scoped under the .wxdh wrapper, and the wrapper carries its own local CSS reset and explicit base typography. That means your theme’s CSS cannot distort the docs, and the plugin’s CSS cannot escape to restyle the rest of your site. Re-skinning is done by overriding a few CSS custom properties (variables) — no template hacking required.
Shortcodes
[wxdh]— full documentation layout (search + sidebar + a card for each documentation).[wxdh set="developer-api"]— the same layout scoped to one documentation. Accepts a slug or an ID.[wxdh_search]— a live search box you can place anywhere.[wxdh_list]— a grid of all documentations. ([wxdh_categories]still works as an alias.)
Template overrides
Copy any file from the plugin’s /templates/ folder into your-theme/wxdh/ to customise it safely — it will survive plugin updates.
Installation
- Upload the
webxpart-documentation-hubfolder to/wp-content/plugins/, or install the ZIP via Plugins Add New Upload Plugin. - Activate the plugin.
- Go to Webxpart Documentation Hub Documentations and create your first documentation, then use “Add child” to build out its sections and articles.
- Create a page (e.g. “Documentation”) containing the
[wxdh]shortcode, then select it under Webxpart Documentation Hub Settings Documentation home. Your theme renders that page normally, so the docs sit inside your own header and footer. - Configure the remaining options under Webxpart Documentation Hub Settings.
FAQ
-
Does it work with my theme?
-
Yes. Webxpart Documentation Hub never renders the page itself — your theme does, exactly as it does for any other post or page. The plugin only adds its doc UI inside the content area, wrapped in an isolated, self-contained container. This works the same on classic and block (FSE) themes.
-
Can I change the colours?
-
Yes — override the CSS variables (e.g.
--wxdh-accent) on the.wxdhselector in your theme’s stylesheet. Dark mode is automatic based on the visitor’s system preference. -
What data does the plugin collect?
-
Only what it needs to show you the Insights screen, and all of it stays in your own database — nothing is ever sent anywhere.
Search analytics store the search term and how many results it returned. Feedback stores the vote, any comment left, and a salted one-way hash built from the visitor’s IP address and browser. The hash exists solely to stop the same person voting twice on one page; the IP address itself is never stored and cannot be recovered from it. No cookies are set, and no personal data is collected.
Both features can be switched off under Webxpart Documentation Hub Settings, and everything recorded can be deleted at any time from Webxpart Documentation Hub Insights.
-
Will my docs be deleted if I uninstall?
-
No. Your docs and categories stay in the database and reappear if you install the plugin again.
Uninstalling removes the plugin’s own data only: its settings, the feedback and search-analytics tables, and the per-doc counters (views and helpful/unhelpful votes) stored as post meta.
Reviews
There are no reviews for this plugin.
Contributors & Developers
“Webxpart Documentation Hub” is open source software. The following people have contributed to this plugin.
Contributors
Translate “Webxpart Documentation Hub” into your language.
Interested in development?
Browse the code, check out the SVN repository, or subscribe to the development log by RSS.
Changelog
1.0.0
- Initial release.
- Multiple documentations, each a top-level doc with unlimited nesting beneath it.
- Reader feedback (“Was this page helpful?”) with an optional comment on negative votes.
- Insights screen: lowest-rated docs, most-viewed docs, top searches and searches that returned nothing.
- Access control per documentation: public, logged-in only, or restricted to chosen roles.
- Documentations admin screen for building and reordering the tree.
- Live AJAX search, automatic table of contents, breadcrumbs and previous/next navigation.
- Shortcodes:
[wxdh],[wxdh set="..."],[wxdh_search]and[wxdh_list]. - Self-contained or theme-inheriting design modes, with automatic dark mode.