History

Kate Temkin c893a86e54 initial commit of template		2024-04-26 22:49:34 -06:00
..
lib	initial commit of template	2024-04-26 22:49:34 -06:00
vendor	initial commit of template	2024-04-26 22:49:34 -06:00
cli.js	initial commit of template	2024-04-26 22:49:34 -06:00
index.js	initial commit of template	2024-04-26 22:49:34 -06:00
LICENSE	initial commit of template	2024-04-26 22:49:34 -06:00
package.json	initial commit of template	2024-04-26 22:49:34 -06:00
README.md	initial commit of template	2024-04-26 22:49:34 -06:00

README.md

hugo-bin

Binary wrapper for Hugo

Install

npm install hugo-bin --save-dev

hugo-bin now supports the Extended Hugo version. See Installation options for more details.

Usage

API

const { execFile } = require('child_process');
const hugo = require('hugo-bin');

execFile(hugo, ['version'], (error, stdout) => {
  if (error) {
    throw error;
  }

  console.log(stdout);
});

CLI

$(npm bin)/hugo --help
npm run create -- post/my-new-post.md # 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/my-new-post.md

npm run-script

{
  "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"
  }
}

Also as local or global .npmrc configuration file:

hugo_bin_build_tags = "extended"

Also as an environment variable:

export HUGO_BIN_BUILD_TAGS="extended"

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.