Skip to content

Latest commit

 

History

History
30 lines (18 loc) · 1.22 KB

README.md

File metadata and controls

30 lines (18 loc) · 1.22 KB
Raw

mochajs.org

So you wanna build the site?

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

Prerequisites

  • Node.js v8.x or greater

Development

  1. Run npm install from working copy root to get Node.js deps.
  2. To serve the site and rebuild as changes are made, execute npm start docs.watch.
  3. To rebuild the site once, execute npm start docs.

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/_dist is where the deployed site lives. docs/_site is essentially a build step. These directories are not under version control.
  • See package-scripts.js for details on what the builds are actually doing; especially see markdown-magic for how we're dynamically inserting information into docs/index.md.

License

©️ 2016-2018 JS Foundation and contributors.

Content licensed CC-BY-4.0.

Code licensed MIT.