Skip to content

Latest commit

 

History

History
33 lines (21 loc) · 1.27 KB

README.md

File metadata and controls

33 lines (21 loc) · 1.27 KB
Raw

mochajs.org

So you wanna build the site?

mochajs.org is built using Jekyll, the popular static site generator.

Prerequisites

  • Ruby
  • RubyGems
  • Bundler (gem install bundler)
  • Node.js v4.0.0 or greater

Development

  1. Run npm install to get Node.js deps.
  2. Run bundle install to install Jekyll and its dependencies. This may or may not require elevated privileges, depending on your system.
  3. To serve the site and rebuild as changes are made, execute npm run serveDocs.
  4. To rebuild the site once, execute npm start buildDocs.

Notes

  • The content lives in docs/index.md; everything else is markup, scripts, assets, etc.
  • docs/index.md may be mutated upon build. If you update the table of contents, you must commit index.md; GitHub won't do it for you.
  • docs/_site/ is where the generated static site lives (and is what you see at mochajs.org). It is not under version control.

License

©️ 2016-2017 JS Foundation and contributors.

Content licensed CC-BY-4.0.

Code licensed MIT.