Join the conversation

Enter your site. It reads the sitemap, checks up to 50 pages and lists duplicate titles, missing descriptions and broken link previews, with the affected URLs.

Build a secure, SSR-safe reader-feedback widget for your Docusaurus blog — text selection, 4 feedback types, PHP API with HMAC nonce, rate limiting, deduplication, admin dashboard, and email notificat...

Working code for Astro, Starlight and Docusaurus, plus which schema.org types fit docs and blogs, common mistakes and how to validate.

The Docusaurus settings that matter for search: front matter, preview images, noindex, sitemap rules, trailing slash pitfalls and JSON-LD.

Docusaurus is a static site generator for documentation, built on React and Webpack. This post walks through its build pipeline, from config to the files written to disk.

5 minutes to learn the most important Docusaurus concepts.

Why Docusaurus, Starlight and VitePress sites repeat the same title or description across pages, how to find them in your build, and how to fix them.

Your product ships Friday. Your documentation is a 3-year-old Confluence page and a README nobody has touched since launch. That mismatch quietly costs you users, support tickets and contributor goodwill. Here is the exact workflow I use to go from raw repo content to a live, professional documentation site in 24 hours. ## 1. Pick the framework in 10 minutes * **Docusaurus** (React): best when you need API reference pages, MDX components, heavy versioning, or a React-based landing page around the docs. * **MkDocs + Material** (Python): best when you want the fastest setup, a beautiful theme out of the box, and a simpler mental model for non-developer contributors. Decision rule: if your content is maintained by developers in a repo, either works — pick the one matching your stack's language. ## 2. Bootstrap with intent (not the default demo) `scaffold -> theme config -> nav structure`. The information architecture matters more than the theme: versioned docs, guides separated from reference, a search that actually works. Do this before writing a single page. ## 3. Restructure the content * Convert buried Markdown into the new sidebar structure (fix every relative link — this is where migrations die) * Split wall-of-text pages into scannable sections * Move setup/quickstart to the front page — users decide in 30 seconds ## 4. Generate the API reference from OpenAPI If the product ships an API, never hand-write the reference. Generate it from the OpenAPI spec (Redoc, Stoplight, or the Docusaurus OpenAPI docs plugin) so it regenerates on every spec change. ## 5. CI/CD so docs can never go stale GitHub Actions on every merge -> build -> deploy to GitHub Pages/Netlify/Vercel. Docs PRs go through review like code PRs. A docs site without CI is a wiki — it rots. ## 6. The finishing checklist I run on every deliverable * All internal links resolve (link checker in CI) * Mobile nav usable, dark mode correct * Full-text search returns relevant results * `sitemap.xml` clean, and an `llms.txt` so AI assistants index the docs properly * Deployment proof: the site rebuilds from a clean clone That's the whole system. The "24 hours" is real when the pipeline exists — the second site for the same team takes half a day. I run this as a service for software teams (24h turnaround, Docusaurus and MkDocs). If you have questions about your own docs setup, ask in the comments — happy to help.

App Crash Lab: check saved state after reload and rejected updates; export diffs and Playwright tests. Includes Demo Forge for repeatable README videos. Local-first OSS. - aichance/business-ai-recipes

Build an interactive map of your whole Docusaurus corpus — every article as a bubble wearing the site's mascot, sized by how many other posts link to it, positioned by a force-directed layout that run...

A feature your visitors cannot find does not exist. This article adds a floating "Ask my blog" bubble to a Docusaurus site — a third entry point into the same question index, and the first one that ne...

Starlight plugin to give your sidebar groups their own pages.

A local LLM reads every article on your blog and writes the questions a developer would actually type into a search bar, each one mapped to the exact heading that answers it. The result is a build-tim...

A JS library for predictable and maintainable global state management

Supersedes #4792 Fixes #4789 (eventually) In #4792 , I experimented with a Git-based approach (using submodules, I think) to pulling in the other repos so we could use Docusaurus's multi-instan...

Build a "Copy as Markdown" button and a "View raw" link for your Docusaurus blog posts — a build-time plugin that writes a plain-Markdown mirror next to every article, plus the tiny React component th...