From 7057638698d03f41b0ae0eec297d9e9fa3938c6a Mon Sep 17 00:00:00 2001 From: Christopher Hiller Date: Wed, 18 Apr 2018 09:38:28 -0700 Subject: [PATCH] update outdated info in docs/README.md [ci skip] Signed-off-by: Christopher Hiller --- docs/README.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/docs/README.md b/docs/README.md index 928bbfe9d7..56aa8a5c7e 100644 --- a/docs/README.md +++ b/docs/README.md @@ -13,20 +13,21 @@ ## Development -1. Run `npm install` to get Node.js deps. +1. Run `npm install` from working copy root to get Node.js deps. 1. Run `bundle install` to install Jekyll and its dependencies. This may or may not require elevated privileges, depending on your system. -1. To serve the site and rebuild as changes are made, execute `npm run serveDocs`. -1. To rebuild the site *once*, execute `npm start buildDocs`. +1. To serve the site and rebuild as changes are made, execute `npm run docs.watch`. +1. To rebuild the site *once*, execute `npm start docs.build`. ### 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. +- This file (`docs/README.md`) should *not* be included in the build. +- `docs/index.md` may be mutated upon build, depending on what `scripts/docs-update-toc.js` does. If it updates the table of contents (because of your changes), **you must commit `docs/index.md`**. - `docs/_site/` is where the generated static site lives (and is what you see at [mochajs.org](https://mochajs.org)). It is *not* under version control. ## License -:copyright: 2016-2017 [JS Foundation](https://js.foundation) and contributors. +:copyright: 2016-2018 [JS Foundation](https://js.foundation) and contributors. Content licensed [CC-BY-4.0](https://raw.githubusercontent.com/mochajs/mocha/master/docs/LICENSE-CC-BY-4.0).