Skip to content

Docusaurus

Docusaurus turns documentation files into a website and can keep separate instructions for different product releases.

Visit Docusaurus

What do you need before you can read the first page?

Set up the project with Node.js and keep the docs as Markdown files. The build creates a folder of ready-to-serve pages and assets. Your team chooses where that folder is hosted. The Docusaurus project uses the MIT license. Budget for hosting and someone to maintain the build.

When do two versions of a guide help readers?

Keep separate versions if users of different product releases need different instructions. Docusaurus can copy a version’s pages into a preserved set. The docs you edit today can be kept separate from the set readers see by default. Start with one set if everybody uses the same live app.

Which files would you keep if you changed hosts?

Keep the Markdown pages, version folders, sidebar configuration and referenced images alongside the build setup. You can deploy the generated site to another static host. If you change generators, test old version URLs and links in the new site.

How would you check two versions of a setup guide?

Sketch this with fictional material. Leave the real site, accounts and services alone.

  1. Write two valid instructions
    A fictional app places Invite teammate in Settings on release 1 and in Members on release 2.
  2. Label both copies
    Mark which guide opens first and how a person using release 1 would reach the earlier steps.
  3. Check one saved address
    Pick an old guide URL on paper and mark where it should lead after a rebuild.