mirror of
https://github.com/jakejarvis/hugo-extended.git
synced 2025-04-26 16:58:26 -04:00
73 lines
1.3 KiB
Markdown
73 lines
1.3 KiB
Markdown
# hugo-bin [](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.
|
|
|
|
## Configuration
|
|
|
|
This can be form of a `hugoBin` field in a `package.json` file.
|
|
|
|
```
|
|
{
|
|
"name": "some-package",
|
|
"version": "1.0.0",
|
|
"hugoBin": {
|
|
"hugoVersion": "0.15"
|
|
}
|
|
}
|
|
```
|
|
|
|
- `hugoVersion` - Hugo binary version (defualt: See [`hugo-bin/package.json`](package.json) file).
|
|
The supported version is `>=0.10`.
|
|
|
|
## 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)
|
|
|
|
## License
|
|
|
|
MIT © [Shun Sato](http://blog.fenneclab.com/)
|