mirror of
https://github.com/WordPress/WordPress.git
synced 2024-10-30 15:31:04 +01:00
3e0408db89
This adds in a useful file to know how to compiled this theme. As there was previously a contributing file with instruction on this in the GitHub repo that was not brought into svn, this fixes that. Props kjeller, nielslange, sabernahardt. Fixes #46108. Built from https://develop.svn.wordpress.org/trunk@58451 git-svn-id: http://core.svn.wordpress.org/trunk@57900 1a063a9b-81f0-0310-95a4-ce76da25c4cd
20 lines
1.2 KiB
Plaintext
20 lines
1.2 KiB
Plaintext
=== Contributing to Twenty Nineteen ===
|
||
|
||
= Compiling SCSS =
|
||
|
||
Twenty Nineteen relies on Sass, which allows us to more easily share code between multiple stylesheets (style.css, style-editor.css, etc.). To compile Sass files (.scss), use the built-in npm build tool. The build tool will make sure that your compiled CSS code stays in sync and has the correct formatting.
|
||
|
||
Installation instructions
|
||
|
||
1. Using a command line interface, go to the “twentynineteen” directory `cd /my-computer/local-wordpress-install/src/wp-content/themes/twentynineteen`.
|
||
|
||
2. Type `npm install` into the command line, and press the [return] key, to install all Node.js dependencies.
|
||
|
||
3. The dependencies may take a few minutes to download but once it completes, you’re done.
|
||
|
||
Usage instructions
|
||
|
||
1. After making a change to a .scss file, run `npm run build` from within the theme directory to build the CSS files with your new changes. You may need to run the build command twice to update style-rtl.css (because the RTL process might update from style.css before that is updated from Sass file changes).
|
||
|
||
2. You can also “watch” the theme directory for Sass changes and rebuild the CSS anytime a change occurs by running: `npm run watch`.
|