Skip to content

Latest commit

 

History

History
 
 

docs

README.md

mochajs.org

So you wanna build the site?

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

Prerequisites

  • Node.js v10.12.0 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.
  • If you get the error message below when running npm start docs, follow this guide to install GraphicsMagick or ImageMagick.
⚠ WARN: docs/_site/images/matomo-logo.png: Error executing Stream: The gm stream ended without emitting any data
(node:45255) UnhandledPromiseRejectionWarning: Error: docs/_site/images/matomo-logo.png: Error executing Stream: The gm stream ended without emitting any data
    at Socket.stdout.on.once (/Users/username/mocha/node_modules/express-processimage/lib/getFilterInfosAndTargetContentTypeFromQueryString.js:821:31)
    at Object.onceWrapper (events.js:286:20)
    at Socket.emit (events.js:203:15)
    at endReadableNT (_stream_readable.js:1145:12)
    at process._tickCallback (internal/process/next_tick.js:63:19)
(node:45255) UnhandledPromiseRejectionWarning: Unhandled promise rejection. This error originated either by throwing inside of an async function without a catch block, or by rejecting a promise which was not handled with .catch(). (rejection id: 2)
(node:45255) [DEP0018] DeprecationWarning: Unhandled promise rejections are deprecated. In the future, promise rejections that are not handled will terminate the Node.js process with a non-zero exit code.
cp: docs/_dist/_headers: No such file or directory
  • See package-scripts.js for details on what the builds are actually doing.

License

©️ 2016-2018 JS Foundation and contributors.

Content licensed CC-BY-4.0.

Code licensed MIT.