Plug-and-play Node.js wrapper for Hugo Extended, the awesomest static-site generator. ✏️ https://www.npmjs.com/package/hugo-extended
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
Jake Jarvis 55e4269f5e
use actions/setup-node@v2
3 weeks ago
.github/workflows use actions/setup-node@v2 3 weeks ago
lib remove macOS 32-bit binary (dropped by Hugo) 4 months ago
test Clean up tests 10 months ago
.editorconfig allow binaries in vendor folder to be cached 11 months ago
.gitattributes allow binaries in vendor folder to be cached 11 months ago
.gitignore further simplify install logic 1 year ago
LICENSE.md update readme, license, etc. 1 year ago
README.md Update README.md 6 months ago
cli.js allow binaries in vendor folder to be cached 11 months ago
index.js allow binaries in vendor folder to be cached 11 months ago
package-lock.json Hugo v0.80.0 3 weeks ago
package.json Hugo v0.80.0 3 weeks ago

README.md

Hugo via NPM CI status npm Dependabot

Plug-and-play binary wrapper for Hugo Extended, the awesomest static-site generator.

Installation

npm install hugo-extended --save-dev
# or...
yarn add hugo-extended --dev

hugo-extended defaults to the extended version of Hugo on supported platforms, and automatically falls back to vanilla Hugo if unsupported (mainly on 32-bit systems).

This package's version numbers align with Hugo's — hugo-extended@0.64.1 installs Hugo v0.64.1, for example.

Usage

The following examples simply refer to executing Hugo as a local Node dependency. See the official Hugo docs for guidance on actual Hugo usage.

via CLI / package.json:

{
  "scripts": {
    "build": "hugo",
    "start": "hugo server --buildDrafts --buildFuture --port 1313"
  }
}
$ npm start

Building sites …

                   | EN
-------------------+------
  Pages            |  50
  Paginator pages  |   0
  Non-page files   | 138
  Static files     |  39
  Processed images |  63
  Aliases          |   0
  Sitemaps         |   1
  Cleaned          |   0

Built in 2361 ms
Serving pages from memory
Web Server is available at http://localhost:1313/ (bind address 127.0.0.1)

via API:

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

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

  console.log(stdout);
});

Examples

License

Forked from fenneclab/hugo-bin under the MIT License, (c) Shun Sato.

Hugo is distributed under the Apache License 2.0.