Publish product documentation and a help centre
Write, host and search a documentation site for your product so customers can answer their own questions.
This is for a small software team, freelancer or maker who needs a proper docs site without paying for a hosted documentation service. Writing lives in Git, Docusaurus builds the site, Caddy serves it with HTTPS, and Meilisearch gives visitors fast search. Umami shows which pages people read.
-
1
docusaurus
Builds the documentation site from Markdown files, with versions, sidebar and a blog for release notes.
Instead of Hosted documentation platform. MIT Worth a lookProof level: Read
-
2
gitea
Stores the docs source in Git so changes are reviewed and tracked before publishing.
Instead of GitHub. MIT Ready to useProof level: Read
-
3
caddy
Serves the built site from your own server and handles HTTPS certificates automatically.
Instead of . Apache-2.0 Ready to useProof level: Read
-
4
meilisearch
Provides typo-tolerant search across all pages.
Instead of Algolia. BUSL Check the licenceProof level: Read
-
5
umami
Shows which pages are read and which searches or visits lead nowhere, so you know what to write next.
Instead of Mixpanel. MIT Worth a lookProof level: Seen
Before you start
['Connecting Docusaurus to Meilisearch usually needs a community plugin or a small indexing script, so expect some setup time and re-indexing after each publish.', 'Meilisearch uses the BUSL licence, which is source-available rather than fully open source. Check it suits your use, especially if you resell anything.', 'Self-hosting Gitea, Meilisearch and Umami means you run updates and backups. If you only need a static site, a free static host for the Docusaurus output is less work.', 'meilisearch is source-available, not open source: check what its licence allows before using it for clients.']