mirror of
https://github.com/jakejarvis/hugo-extended.git
synced 2025-04-26 10:05:23 -04:00
71 lines
2.2 KiB
Markdown
71 lines
2.2 KiB
Markdown
# <img src="https://raw.githubusercontent.com/gohugoio/gohugoioTheme/master/static/images/hugo-logo-wide.svg?sanitize=true" alt="Hugo" width="115"> via NPM [](https://github.com/jakejarvis/hugo-extended/actions) [](https://www.npmjs.com/package/hugo-extended) [](https://github.com/gohugoio/hugo) [](https://github.com/jakejarvis/hugo-extended/pulls?q=is%3Apr+label%3Adependencies)
|
|
|
|
> Plug-and-play binary wrapper for [Hugo Extended](https://gohugo.io/), the awesomest static-site generator.
|
|
|
|
## Install
|
|
|
|
```sh
|
|
npm install hugo-extended --save-dev
|
|
# or...
|
|
yarn add hugo-extended --dev
|
|
```
|
|
|
|
`hugo-extended` defaults to the [extended version](https://gohugo.io/getting-started/installing/#linux) of Hugo on [supported platforms](https://github.com/gohugoio/hugo/releases), and falls back to vanilla Hugo automatically if unsupported.
|
|
|
|
## Usage
|
|
|
|
See the [Hugo Documentation](https://gohugo.io/documentation/) for additional functionality.
|
|
|
|
### package.json
|
|
|
|
```json
|
|
{
|
|
"scripts": {
|
|
"build": "hugo",
|
|
"start": "hugo serve",
|
|
"create": "hugo new"
|
|
}
|
|
}
|
|
```
|
|
|
|
#### CLI:
|
|
|
|
```sh
|
|
$(npm bin)/hugo --help
|
|
npm run create -- post/my-new-post.md
|
|
```
|
|
|
|
or on Windows:
|
|
|
|
```bat
|
|
for /f "delims=" %F in ('npm bin') do call "%F\hugo" help
|
|
npm run create -- post/my-new-post.md
|
|
```
|
|
|
|
---
|
|
|
|
### API
|
|
|
|
```js
|
|
const { execFile } = require('child_process');
|
|
const hugo = require('hugo-extended');
|
|
|
|
execFile(hugo, ['version'], (error, stdout) => {
|
|
if (error) {
|
|
throw error;
|
|
}
|
|
|
|
console.log(stdout);
|
|
});
|
|
```
|
|
|
|
## Examples
|
|
|
|
- [jakejarvis/jarv.is](https://github.com/jakejarvis/jarv.is)
|
|
|
|
## License
|
|
|
|
Forked from [fenneclab/hugo-bin](https://github.com/fenneclab/hugo-bin) under the [MIT License](https://github.com/fenneclab/hugo-bin/blob/master/LICENSE), (c) [Shun Sato](http://blog.fenneclab.com/).
|
|
|
|
Hugo is distributed under the [Apache License 2.0](https://github.com/gohugoio/hugo/blob/master/LICENSE).
|