|
1 | | -Blank Theme |
2 | | -=== |
| 1 | +# Blank Theme |
3 | 2 |
|
4 | | -Blank Theme is a custom blank theme created with underscore theme, which includes foundation basic grid system and some basic customizer settings which are required in almost all projects. |
| 3 | +Blank Theme is a custom blank theme created with the underscore theme, which includes the Foundation basic grid system and some basic customizer settings required in almost all projects. |
5 | 4 |
|
| 5 | +## Getting Started |
6 | 6 |
|
7 | | - |
8 | | -Getting Started |
9 | | ---------------- |
10 | | - |
11 | | -After cloning repo run |
| 7 | +After cloning the repo, run the following: |
12 | 8 |
|
13 | 9 | ```bash |
14 | 10 | npm install |
15 | 11 | ``` |
16 | 12 |
|
17 | | -and then run the following command which will prompt for the theme name, start renaming and do cleanup. |
| 13 | +Then run the following command which will prompt for the theme name, start renaming, and clean up: |
18 | 14 |
|
19 | 15 | ```bash |
20 | 16 | npm run init |
21 | 17 | ``` |
22 | 18 |
|
23 | | - |
24 | | - |
25 | 19 | #### Compile Assets |
26 | 20 |
|
27 | | -``` |
28 | | -npm run dev # During development |
29 | | -npm run prod # When ready for production |
30 | | -``` |
31 | | - |
| 21 | +To compile assets, use the following commands: |
32 | 22 |
|
| 23 | +```bash |
| 24 | +npm run build:dev # During development |
| 25 | +npm run build:prod # When ready for production |
| 26 | +``` |
33 | 27 |
|
34 | 28 | #### Other Commands |
35 | 29 |
|
36 | 30 | ```bash |
37 | | -# Generate pot files |
38 | | -npm run pot |
| 31 | +# Generate POT files |
| 32 | +npm run build:pot |
| 33 | + |
| 34 | +# Lint all at once |
| 35 | +npm run lint:all |
| 36 | + |
| 37 | +# Lint only staged files |
| 38 | +npm run lint:staged |
39 | 39 |
|
40 | | -# Lint CSS, JS and PHP |
| 40 | +# Lint individual CSS, JS, PHP and package.json |
41 | 41 | npm run lint:css |
| 42 | +npm run lint:css:fix |
42 | 43 | npm run lint:js |
| 44 | +npm run lint:js:fix |
| 45 | +npm run lint:js:report |
43 | 46 | npm run lint:php |
44 | 47 | npm run lint:php:fix |
| 48 | +npm run lint:package-json |
45 | 49 | ``` |
46 | 50 |
|
| 51 | +#### Before Commit |
47 | 52 |
|
48 | | - |
49 | | -#### Before commit |
50 | | - |
51 | | -This `precommit` script will lint your scss, js, php files and also generate pot file. |
| 53 | +This `precommit` script will lint your SCSS, JS, PHP files and also generate the POT file: |
52 | 54 |
|
53 | 55 | ```bash |
54 | 56 | npm run precommit |
55 | 57 | ``` |
56 | 58 |
|
| 59 | +## Does this interest you? |
57 | 60 |
|
58 | | - |
59 | | -Does this interest you? |
60 | | ---------------- |
61 | | -< a href= "https://rtcamp.com/">< img src= "https://rtcamp.com/wp-content/uploads/sites/2/2019/04/[email protected]" alt= "Join us at rtCamp, we specialize in providing high performance enterprise WordPress solutions"></ a> |
| 61 | +< a href= "https://rtcamp.com/">< img src= "https://rtcamp.com/wp-content/uploads/sites/2/2019/04/[email protected]" alt= "Join us at rtCamp, we specialize in providing high performance enterprise WordPress solutions"></ a> |
0 commit comments