Browse Source

update readme, license, etc.

Jake Jarvis 2 years ago
Signed by: jake GPG Key ID: 2B0C9CF251E69A39
  1. 4
  2. 94
  3. 11


@ -1,6 +1,6 @@
The MIT License (MIT)
MIT License
Copyright (c) 2016 FennecLab
Copyright (c) 2020-present Jake Jarvis <>, (c) 2016 FennecLab.
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal


@ -1,14 +1,16 @@
# hugo-bin [![npm version](]( [![Build Status](]( [![dependencies Status](]( [![devDependencies Status](](
# hugo-node [![CI status](](.github/workflows) [![Hugo v0.63.2](]( [![Dependabot](](
> Binary wrapper for [Hugo](
> Plug-and-play binary wrapper for [Hugo](, the awesomest static-site generator.
## Install
npm install hugo-bin --save-dev
npm install hugo-node --save-dev
# or...
yarn add hugo-node --dev
hugo-bin now supports the [Extended Hugo version]( See [Installation options](#installation-options) for more details.
`hugo-node` defaults to the [extended version]( of Hugo on [supported platforms](, and falls back to vanilla Hugo automatically if unsupported.
## Usage
@ -16,7 +18,7 @@ hugo-bin now supports the [Extended Hugo version](
const { execFile } = require('child_process');
const hugo = require('hugo-bin');
const hugo = require('hugo-node');
execFile(hugo, ['version'], (error, stdout) => {
if (error) {
@ -27,88 +29,40 @@ execFile(hugo, ['version'], (error, stdout) => {
### CLI
$(npm bin)/hugo --help
npm run create -- post/ # see below 'npm run-script'
or on Windows:
for /f "delims=" %F in ('npm bin') do call "%F\hugo" help
rem see below 'npm run-script'
npm run create -- post/
### npm run-script
### package.json
"scripts": {
"build": "hugo",
"create": "hugo new",
"serve": "hugo server"
See the [Hugo Documentation]( for more information.
## Installation options
hugo-bin supports options to change the variation of Hugo binaries.
Each option can be configured in the `hugo-bin` section of your `package.json`:
"name": "your-package",
"version": "0.0.1",
"hugo-bin": {
"buildTags": "extended"
"start": "hugo serve",
"create": "hugo new"
Also as local or global [.npmrc]( configuration file:
hugo_bin_build_tags = "extended"
Also as an environment variable:
#### CLI
export HUGO_BIN_BUILD_TAGS="extended"
$(npm bin)/hugo --help
npm run create -- post/
**Note that you have to run `npm install hugo-bin` to re-install hugo-bin itself, if you change any of these options.**
### Options
#### buildTags
Default: `""`
Set it to `extended` to download the [extended version]( binary.
If this is set to `extended` but it's not available for the user's platform, then the normal version will be downloaded instead.
## Supported versions
See [the package.json commit history](
or on Windows:
## Full example
for /f "delims=" %F in ('npm bin') do call "%F\hugo" help
npm run create -- post/
- [fenneclab/](
See the [Hugo Documentation]( for additional functionality.
## Super Inspired By
## Examples
- [mastilver/apex-bin](
- [imagemin/jpegtran-bin](
- [jakejarvis/](
## License
MIT © [Shun Sato](
Forked from [fenneclab/hugo-bin]( under the [MIT License](, (c) [Shun Sato](
Hugo is distributed under the [Apache License 2.0](


@ -1,10 +1,19 @@
"name": "@jakejarvis/hugo",
"name": "hugo-node",
"version": "0.63.2",
"hugoVersion": "0.63.2",
"description": "Binary wrapper for Hugo",
"repository": "jakejarvis/hugo-node",
"license": "MIT",
"keywords": [
"static site generator"
"main": "index.js",
"bin": {
"hugo": "cli.js"