Skip to main content

Docusaurus

Archibald ships a Docusaurus documentation-site scaffolder: a one-command way to add a docs site next to the application code.

Setup​

The scaffolder is built into @archibald/cli, so there is no integration package to install. In an Archibald project:

# interactive (prompts for the root directory)
archibald add docusaurus

# non-interactive
archibald add docusaurus -r docs

This:

  • verifies the project is initialized (archibald.json present) and the target directory does not already exist,
  • records the docs output path under project.output.paths.docusaurus in archibald.json,
  • runs create-docusaurus <rootDir> classic --yes to generate the site.

There is no bundled template directory — the site is generated on demand via create-docusaurus, so you always start from the current upstream Docusaurus scaffold. From there, the generated site is a plain Docusaurus project: run and build it with its own scripts, independent of the Archibald build.

Further documentation​