diff --git a/README.md b/README.md index 3ff12273c8..25d9a4f5fb 100644 --- a/README.md +++ b/README.md @@ -17,6 +17,7 @@ Prism depends on community contributions to expand and cover a wider array of us - Read the [documentation](https://prismjs.com/extending.html). Prism was designed to be extensible. - Do not edit `prism.js`, it’s just the version of Prism used by the Prism website and is built automatically. Limit your changes to the unminified files in the `components/` folder. `prism.js` and all minified files are also generated automatically by our build system. +- Use `npm ci` to install Prism's dependencies. Do not use `npm install` because it will cause non-deterministic builds. - The build system uses [gulp](https://github.com/gulpjs/gulp) to minify the files and build `prism.js`. With all of Prism's dependencies installed, you just need to run the command `npm run build`. - Please follow the code conventions used in the files already. For example, I use [tabs for indentation and spaces for alignment](http://lea.verou.me/2012/01/why-tabs-are-clearly-superior/). Opening braces are on the same line, closing braces on their own line regardless of construct. There is a space before the opening brace. etc etc. - Please try to err towards more smaller PRs rather than a few huge PRs. If a PR includes changes that I want to merge and also changes that I don't, handling it becomes difficult. diff --git a/docs/index.html b/docs/index.html index 9c1b31287a..23c5e5bf18 100644 --- a/docs/index.html +++ b/docs/index.html @@ -63,6 +63,7 @@

Contribute to Prism!