/mochajs.github.io

Mocha's gopher server

Primary LanguageJavaScript

mochajs.org: How to Build the Site

So you wanna build the site?

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

Prerequisites

  1. Some recent version of Ruby
  2. Some version of RubyGems
  3. Some recent version of Node.JS

Installation

  1. Execute npm install. This will install Bundler, Jekyll, and markdown-toc-index.
  2. To build, execute npm run build or make build

Local development

  1. Run make to build the project and start a development server that auto-watches for changes on http://localhost:3000

For more information, refer to the Jekyll Docs and GitHub's Tutorial on the subject.

Notes

  • To update index.md with the TOC, execute: node_modules/.bin/toc-idx -i index.md --max-depth 1 --bullet "\- " index.md
  • bundle exec jekyll build rebuilds the site without updating the TOC
  • The _site directory is where the generated site lives. It is not under version control, because GitHub Pages generates it for us.