1
mirror of https://github.com/jakejarvis/hugo-extended.git synced 2025-04-26 04:25:21 -04:00
hugo-extended/README.md
2020-02-18 17:45:21 -05:00

2.2 KiB

Hugo via NPM CI status npm Hugo v0.64.1 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).

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

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.