Skip to content

Latest commit

 

History

History
 
 

README.md

mochajs.org

These are the docs for the classic version of mochajs.org. For the Astro site released in 2025, see docs-next.

The classic mochajs.org is built using Eleventy, a simple static site generator.

Development

  1. Run npm install / npm ci from working copy root to get Node.js deps.
  2. To include the API documentation, run npm run docs:api before the either of the following commands.
  3. To serve the site and rebuild as changes are made, run npm run docs-watch.
  4. To rebuild the site once, run npm run docs. This also builds the Astro site.
  5. To preview the site, run npm run docs:preview. The Astro site is available at /next.

Notes

  • The content lives in docs/index.md; everything else is markup, scripts, assets, etc.
  • This file (docs/README.md) should not be included in the build.
  • docs/_site_ is where the deployed site lives. This directory is not under version control.