From 6f1d904a608da50cf4fcd02aa2428cd0f600d0d4 Mon Sep 17 00:00:00 2001 From: Michael Schmidt Date: Thu, 2 Dec 2021 10:51:17 +0100 Subject: [PATCH] Readme: Clarify usage of our build system (#3239) --- README.md | 2 +- docs/index.html | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 25d9a4f5fb..711ea63880 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ You can learn more on [prismjs.com](https://prismjs.com/). Prism depends on community contributions to expand and cover a wider array of use cases. If you like it, consider giving back by sending a pull request. Here are a few tips: - 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. +- 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 generated by our build system (see below). - 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. diff --git a/docs/index.html b/docs/index.html index fe4f203c73..fec3654329 100644 --- a/docs/index.html +++ b/docs/index.html @@ -62,7 +62,7 @@

Contribute to Prism!

Prism depends on community contributions to expand and cover a wider array of use cases. If you like it, consider giving back by sending a pull request. Here are a few tips: