Chromium Code Reviews| Index: docs/vulcanize.md |
| diff --git a/chrome/browser/resources/md_downloads/vulcanize_readme.md b/docs/vulcanize.md |
| similarity index 58% |
| rename from chrome/browser/resources/md_downloads/vulcanize_readme.md |
| rename to docs/vulcanize.md |
| index 2be2248ada9519cdbea8f3a6e47bdcd474ada76f..8d8cb2eb1ea66877d82433f4fdbd53bb62cbf69a 100644 |
| --- a/chrome/browser/resources/md_downloads/vulcanize_readme.md |
| +++ b/docs/vulcanize.md |
| @@ -1,8 +1,8 @@ |
| -# Vulcanizing Material Design downloads |
| +# Vulcanizing Material Design pages |
|
Dan Beam
2016/08/10 18:17:41
nit: Material Design * -> Chrome Polymer UIs?
tsergeant
2016/08/11 01:28:27
Done.
|
| `vulcanize` is an npm module used to combine resources. In order to make the |
| -Material Design downloads page sufficiently fast, we run vulcanize on the source |
| -files to combine them and reduce blocking load/parse time. |
| +Material Design downloads and history pages sufficiently fast, we run vulcanize |
| +on the source files to combine them and reduce blocking load/parse time. |
| ## Required software |
| @@ -12,6 +12,7 @@ Vulcanization currently requires: |
| - npm: >= 1.3.10 (can be found with `npm --version`) |
| - vulcanize: 1.14.8 (can be found with `vulcanize --version`) |
| - crisper: 2.0.1 (can be found with `npm list -g crisper`) |
| +- uglifyjs: 2.4.10 (can be found with `uglifyjs --version`) |
| ## Installing required software |
| @@ -24,22 +25,22 @@ We recommend telling npm where to store downloaded modules: |
| $ npm config set -g prefix "$HOME/node_modules" |
| ``` |
| -Then install `crisper` and `vulcanize` like this: |
| +Then install the required modules: |
| ```bash |
| -$ npm install -g crisper vulcanize |
| +$ npm install -g crisper vulcanize uglifyjs |
| ``` |
| -Ultimately, all that is required to run this script is that `crisper` and |
| -`vulcanize` are on your `$PATH`. |
| +Ultimately, all that is required to run this script is that `crisper`, |
| +`vulcanize` and `uglifyjs` are on your `$PATH`. |
| ## Combining resources with vulcanize |
| -To combine all the CSS/HTML/JS for the downloads page to make it production |
| -fast, you can run the commands: |
| +To combine all the CSS/HTML/JS for all pages which use vulcanize, making them |
| +production fast, you can run the command: |
| ```bash |
| -$ chrome/browser/resources/md_downloads/vulcanize.py # from src/ |
| +$ chrome/browser/resources/vulcanize.py # from src/ |
| ``` |
| This should overwrite the following files: |
| @@ -47,8 +48,10 @@ This should overwrite the following files: |
| - chrome/browser/resources/md_downloads/ |
| - vulcanized.html (all <link rel=import> and stylesheets inlined) |
| - crisper.js (all JavaScript, extracted from vulcanized.html) |
| +- chrome/browser/resources/md_history/ |
| + - app.vulcanized.html |
| + - app.crisper.js |
| ## Testing downloads without vulcanizing |
| -Build with "use_vulcanize=0" in your GYP_DEFINES to build downloads without |
| -vulcanizing. |
| +Build with `use_vulcanize = false` in your gn args to build without vulcanizing. |