1
mirror of https://github.com/jakejarvis/hugo-extended.git synced 2025-04-26 16:58:26 -04:00
hugo-extended/README.md
2017-06-29 01:59:08 +09:00

69 lines
1.4 KiB
Markdown

# hugo-bin [![Build Status](https://travis-ci.org/fenneclab/hugo-bin.svg?branch=master)](https://travis-ci.org/fenneclab/hugo-bin)
> Binary wrapper for [Hugo](https://gohugo.io/)
## Install
```
npm install --save-dev hugo-bin
```
## Usage
### API
```js
const execFile = require('child_process').execFile;
const hugo = require('hugo-bin');
execFile(hugo, ['version'], (err, stdout) => {
console.log(stdout);
});
```
### CLI
```sh
$(npm bin)/hugo --help
npm run create -- 'post/my-new-post' # see below 'npm-run-script'
```
### npm-run-script
```json
{
"scripts": {
"build": "hugo",
"create": "hugo new",
"serve": "hugo server -ws"
}
}
```
See the [Hugo Documentation](https://gohugo.io/) for more information.
## Supported versions
| hugo-bin version | Hugo version |
|:-----------------:|:------------:|
| ^0.9.0 | v0.22.1 |
| ^0.8.0 | v0.21 |
| ^0.7.0 | v0.20.7 |
| ^0.6.0 | v0.19 |
| ^0.5.0 | v0.18.1 |
| ^0.4.0 | v0.17 |
| ^0.3.0 | v0.16 |
## Full example
- [fenneclab/blog.fenneclab.com](https://github.com/fenneclab/blog.fenneclab.com)
## Super Inspired By
- [mastilver/apex-bin](https://github.com/mastilver/apex-bin)
- [imagemin/jpegtran-bin](https://github.com/imagemin/jpegtran-bin)
## License
MIT © [Shun Sato](http://blog.fenneclab.com/)