https://github.com/hmsk/harp-gh-pages-boilerplate
The boilerplate of harp project publishing compiled files to GitHub Pages
https://github.com/hmsk/harp-gh-pages-boilerplate
Last synced: 2 months ago
JSON representation
The boilerplate of harp project publishing compiled files to GitHub Pages
- Host: GitHub
- URL: https://github.com/hmsk/harp-gh-pages-boilerplate
- Owner: hmsk
- Created: 2016-02-07T09:07:54.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2016-06-11T07:52:28.000Z (about 9 years ago)
- Last Synced: 2025-04-02T21:09:50.899Z (3 months ago)
- Language: JavaScript
- Homepage:
- Size: 3.91 KB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# harp-gh-pages-boilerplate
The Boilerplate building static sites with [Harp](http://harpjs.com/) and publishing to [GitHub Pages](https://pages.github.com/) with [gh-pages npm](https://github.com/tschaub/gh-pages)
## Installation
```
$ git clone
$ mkdir your_static_site
$ cp -r harp-gh-pages-boilerplate/{src,bin,package.json,.gitignore,.circle.yml.sample} your_static_site/
$ cd your_static_site
$ npm install
$ npm run preview # And open localhost:9000 on your browser
```
## Usage
### Build static site
```
$ npm run compile
```
You can get compiled files in `dist` directory.
### Launch preview server on `localhost:9000`
```
$ npm run preview
```
### Publish to gh-pages branch
You should initialize yoru project dir as a repository of GitHub at first.
```
$ npm run publish
```
#### Deployment with Circle CI
```
$ mv circle.yml{.sample,}
$ vim circle.yml # Edit git config variables
$ mv src/circle.yml{.sample,} # For ignoring to build when pushed to gh-pages branch
```
And configure your repository in Circle CI **with writable SSH key**.