[MC] Documentation Manager 1.0.0

Documentation Manager hosts your product documentation on your forum, with your members, permissions, search and style. Write pages in Markdown in a split editor with a live preview, arrange them in a sidebar tree, and cut a release whenever you ship, so readers can switch between versions while your editors carry on in the next one. Pages can be restricted to license holders, readers can rate pages and suggest edits, and a space can stay in step with a Docusaurus site in a GitHub repository.



Features

Spaces and reading

• One space per product at /docs/{space}/, each with its own title, icon, description, settings and permissions
• A docs index of every listed space, or straight to one space for a site with a single product
• Three-column pages: a collapsible sidebar tree, the page, and an On this page table of contents that follows your reading
• Breadcrumbs, last updated date and editor, reading time and previous and next links
• Quick search with Ctrl or ⌘ + K, grouped by page with matching headings as their own results
• A Documentation tab in the native search, with a space filter
• Each space can open its first page or an overview with section cards and recent updates
• An announcement bar per space, in three styles, optionally dismissible and with an end date
• Recent updates across every space, and a Copy page menu to copy a page as Markdown or copy its link

Writing in Markdown

• A Markdown editor beside a live preview rendered by the real pipeline, with Write, Split and Preview views and a full screen mode
• A formatting toolbar and an Insert menu for every block, with a sheet of tiles on phones
• Admonitions, tabs that switch together across a page, steps, code groups, file trees, link cards, footnotes, highlights and description lists
• Code blocks with titles, line numbers, highlighted lines and added, removed and focused lines, plus a copy button
• Mermaid diagrams, videos from media sites or uploads, and cards for threads, posts, resources and products
• Links between pages by key, so moving or renaming a page never breaks them. Links to missing pages show in the preview and in a Broken links report.
• Snippets to share text between pages, templates to start new pages from, and variables such as {{ product.version }} filled in when a page is shown
• Images uploaded as attachments and shown in the native lightbox
• Unsaved work is kept in your drafts, so it follows you to another device

Versions and releases

• Versioned spaces keep a Next working copy that only editors see
• Cut a release from Next with a label and release notes; drafts stay behind
• Older versions stay readable as maintained, unmaintained or hidden, with a banner pointing to the same page in the latest version
• Also apply to {version}: save a typo fix to Next and the released version at once, while both pages still match
• Changelog pages list your releases and their notes
• Download any version as a PDF or an ePub book, for the groups you give the download permission

Publishing and history

• Publish now, save a draft, or schedule a page to publish itself at a set time
• Every save is a revision, with a diff against the one before and revert
• A save conflict shows who changed the page and what, before anything is overwritten
• A trash with undo and restore, emptied after 30 days by default
• Moved pages record redirects from their old paths, and you can add your own
• Page owners and review dates, with an alert when a page is due and a Due for review list
• Drag-and-drop page manager with bulk publish, restrict, move, change owner and trash
• Editors can comment on any paragraph, heading, list item, code block or table, with mentions and resolve

Restricted pages

• Restrict chosen pages, or every page in a space with free-to-read exceptions
• Readers without access see the title, a preview and a button to get access; guests also get a log-in button
• Unlock with the View restricted pages permission, or for license holders of linked DBTech eCommerce products, or for users of linked Resource Manager resources or Downloads Manager downloads
• Expired licenses keep access, keep access to releases up to their expiry, or lose it, per space
• The access button comes from the linked product: Buy, Get or Renew
• Linked products, resources and downloads get a Documentation button on their own pages

Reader feedback

• Was this page helpful? under every page, with an optional comment, guests included
• After a No, readers are offered a new thread in your community forum with the page linked
• Suggest an edit: members propose changes in the same Markdown editor, and editors review a line diff in the native approval queue
• Members watch pages or whole spaces, by alert or email, for updates or releases only
• Threads that link to a page are listed under it, optionally topped up with similar threads from Enhanced Search

GitHub sync, import and export

• Sync a space from a Docusaurus site in a GitHub repository on every push, through one repository webhook
• Check connection tells you what to fix in the repository, branch, folder or token
• A site with several docs sections becomes one space per section, and new sections are offered as new spaces
• Import a Docusaurus site from a zip, a server folder or the command line, with a dry run and a redirect map for the old site
• Common MDX components such as Tabs and Admonition are converted, and anything else is reported
• Export any space back to a Docusaurus-style zip

Admin CP and REST API

• An overview of what is waiting: open feedback, suggested edits, pages due for review, broken links and searches with no results
• Analytics for 7, 30 or 90 days or all time: page views per day, most viewed and least helpful pages, top searches and searches with no results
• A REST API for spaces, versions, pages, revisions, suggestions, feedback, redirects, reports, imports and jobs
• CLI commands to import, export and set a repository's sync token or secret

Search engines and AI tools

• Pages in the native sitemap, canonical links to the default version, and breadcrumb structured data
• Hide a space from search engines with one setting
• llms.txt and llms-full.txt for every space, and the Markdown source of any page at its .md URL

Permissions and options

• View documentation: every group that can view forums gets it on install, and without it the whole docs section stays closed
• View restricted pages, and Download versions as PDF or ePub: granted to no one on install
• Rate pages as helpful or not, and Suggest edits to pages: granted to readers and registered members on install
• Editor permissions to view drafts, edit, add, upload, comment, move pages and cut releases, each granted on install to the groups that can edit any post
• Moderator permissions to approve suggested edits, delete, undelete and hard-delete pages, reassign owners and delete comments, each granted on install to the groups with the closest forum permission
• Every permission can be set per space, as with forums
• Options are split across General, Reading, Search, Editing, Feedback and Search engines tabs
• Search all published versions: off by default, so only each space's default version is in site search
• Raw HTML in Markdown: keeps safe formatting tags by default, or shows all HTML as text

Other features

• Recently updated docs and Popular docs pages widgets
• Style properties for column widths, sticky columns, cards, labels and the editor, with every colour taken from your style
• Responsive on mobile, and works in light and dark styles

FAQ

Can I move my existing Docusaurus site over?
Yes. The importer reads the site's files, without running anything, and creates a space per docs section with your versions, sidebars, page paths, images and links. Run a dry run first to see the report. MDX components other than the common ones are unwrapped and listed, so check those pages after the import.

Can I keep writing in GitHub?
Yes. Turn on GitHub sync for a space and every push updates its working version. Sync is one way, so edits made on the forum to synced pages are overwritten by the next push.

Does it contact any outside service?
Only when you ask it to. GitHub sync downloads your repository from GitHub, sending your access token for a private repository. Pages with a Mermaid diagram load the Mermaid script from jsDelivr by default; host the file yourself or clear the Mermaid script option to stop that.

Can search engines read restricted pages?
No. Guests see only the preview, and by default only a restricted page's title, description and headings are indexed for site search.

Is it a wiki that members can edit?
No. Pages are written by the editors you choose. Members can suggest edits, which an editor reviews before anything changes.

What happens when I uninstall it?
Every space, version, page, revision, suggestion, feedback entry, comment, watch and redirect is deleted, with the page attachments. Export your spaces first if you want to keep them.

Is there branding, and can I remove it?
Yes, a small footer credit. Removing it is free: switch it off with the Remove branding option in [MC] Core Library.



Screenshots

Spaces and reading



Writing in Markdown



Versions and releases




Publishing and history



Restricted pages


Reader feedback



GitHub sync, import and export


Admin CP and REST API



Other features