hxuanyu/intellij-sdk-code-samples
1
0
Fork 0
mirror of https://github.com/JetBrains/intellij-sdk-code-samples.git synced 2025-07-30 18:27:49 +08:00
Code Issues Packages Projects Releases Wiki Activity

Add instructions for deploying to GitHub pages

Browse Source
This commit is contained in:
breandan considine 2016-01-15 00:02:13 -08:00
parent 2a45199ac7
commit 2bde4f77f6
1 changed files with 17 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -73,4 +73,21 @@ A set of Rake tasks, a Make-like programs implemented in Ruby, provides short co
in your browser.
**Note:** Make sure you haven't change default Jekyll port during installation.
####Deployment to GitHub Pages
To deploy updates from this repository to GitHub Pages, contributors can take the following steps:
1. Fork `intellij-sdk-docs` and push changes to your local `master` branch.
2. Deployment is possible via `grunt deploy` or by rebuilding `_site` manually.
* Node.js deployment:
* Install [node.js](https://nodejs.org/en/download).
* From parent directory, run: `npm install grunt grunt-exec grunt-build-control --save-dev`
* Run `grunt -v deploy` to commit and push changes to the `gh-pages` branch.
* Manual deployment:
* `rake build[_config-gh-pages.yml]`
* `cd _site`
* `git add -A && git commit -m "Commit message"`
* `git push origin gh-pages`
3. Visit `<YOUR_GH_USERNAME>.github.io/intellij-sdk-docs/` to view the site.