WordPress.org

Make WordPress Core

Ticket #46108: 46108-1.diff

File 46108-1.diff, 1.6 KB (added by nielslange, 3 weeks ago)
  • new file src/wp-content/themes/twentynineteen/contributing.txt

    diff --git a/src/wp-content/themes/twentynineteen/contributing.txt b/src/wp-content/themes/twentynineteen/contributing.txt
    new file mode 100644
    index 0000000000..ad555b2da3
    - +  
     1=== Contributing to Twenty Nineteen ===
     2
     3= Compiling SCSS =
     4
     5Twenty 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.
     6
     7Installation instructions
     8
     91. Using a command line interface, go to the “twentynineteen” directory `cd /my-computer/local-wordpress-install/src/wp-content/themes/twentynineteen`.
     10
     112. Type `npm install` into the command line and press [return], to install all Node.js dependencies.
     12
     133. The dependencies may take a few minutes to download but once it completes, you’re done.
     14
     15Usage instructions
     16
     171. 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.
     18
     192. You can also “watch” the theme directory for Sass changes and rebuild the CSS anytime a change occurs by running: `npm run watch`.
     20
     21Please note that you also need to run `grunt build` or `grunt watch` within `/my-computer/local-wordpress-install/` to compile the changes from `/my-computer/local-wordpress-install/src` to `/my-computer/local-wordpress-install/build`.
     22 No newline at end of file