Skip to content

Commit 6dc644c

Browse files
Ari Kalfusnielsenramon
authored andcommitted
Created NPM scripts in package.json to replace current build commands.
Added Intellij to .gitignore
1 parent d60843a commit 6dc644c

File tree

3 files changed

+9
-3
lines changed

3 files changed

+9
-3
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,3 +11,4 @@ Thumbs.db
1111
/.jekyll-cache/
1212
Gemfile.lock
1313
yarn.lock
14+
.idea

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -61,19 +61,19 @@ On windows, install Ruby and Node with the installers found here:
6161

6262
Next setup your environment:
6363

64-
bin/setup
64+
npm run setup
6565

6666
### Development
6767

6868
Run Jekyll:
6969

70-
bundle exec jekyll serve
70+
npm run local
7171

7272
## Deploy to GitHub Pages
7373

7474
Before you deploy, commit your changes to any working branch except the `gh-pages` one and run the following command:
7575

76-
bin/deploy
76+
npm run publish
7777

7878
**Important note**: Chalk does not support the standard way of Jekyll hosting on GitHub Pages. You need to deploy your working branch (can be any branch, for xxx.github.io users: use another branch than `master`) with the `bin/deploy` script. Reason for this is because Chalk uses Jekyll plugins that aren't supported by GitHub pages. The `bin/deploy` script will automatically build the entire project, then push it to the `gh-pages` branch of your repo. The script creates that branch for you so no need to create it yourself.
7979

package.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
{
22
"name": "chalk",
3+
"scripts": {
4+
"setup": "bin/setup",
5+
"local": "bundle exec jekyll serve --drafts",
6+
"publish": "bin/deploy"
7+
},
38
"dependencies": {
49
"jquery": "^3.2.1",
510
"throttle-debounce-fn": "^1.0.1",

0 commit comments

Comments
 (0)