Skip to main content

Internal docs (docs)

Document all scripts

All Node scripts for /docs should be comprehensively documented here -- no exceptions!

Our internal docs site is powered by Docusaurus v2.

Most common​

Developing​

  • dev: Entry point for development. Starts the Docusaurus development on port 7000, via docusaurus start.

Building and testing​

  • build: Compiles the Docusaurus website to static files in ./docs/build.

Deploying​

  • start: Entry point for starting the production app. Build the app first via build.

Helpers​

  • docusaurus: Run any Docusaurus CLI command via this NPM script.
  • clear: Alias for docusaurus clear. Clear a Docusaurus site's generated assets, caches, build artifacts.