gobot-hugo v0.124.1-alpha.21

Hugo via npm

This package allows you to use Hugo as an npm dependency.

Part of the Gobot project.

Usage

Quick run

npx gobot hugo --version

Quick use

npm i gobot

import { gobot } from 'gobot'
const bot = await gobot(`hugo`)
bot.run([`--version`])

Basic version locking

npm i gobot-hugo

With gobot-hugo present, Gobot will default to the hugo version corresponding to the gobot-hugo version you installed. Now you can use hugo as a real dependency.

import { gobot } from 'gobot'
const bot = await gobot(`hugo`)
bot..run([`--version`])

Locking to a specific version

The gobot-hugo package version always mirrors the underlying hugo version:

npm i gobot-hugo@0.124.1

Override the default version imposed by this package

In rare cases, you may want to intentionally run a different version of hugo even though gobot-hugo is installed.

// Run a specific version (override)
const bot = await gobot(`hugo`, { version: `0.124.1` })
bot.run([`--version`])

// Or the latest version (override)
const bot = await gobot(`hugo`, { version: `*` })
bot.run([`--version`])

Pass environment variables

import { gobot } from 'gobot'
const bot = await gobot(`hugo`, {
  env: process.env, // This is not always necessary, but some apps do need it
})
bot.run([`--version`])

Install globally for CLI access

Exactly one gobot-hugo can be installed globally. It will receive a bin alias:

npm i -g gobot-hugo
hugo --help

# Upgrade to  @latest or any version
npm i -g gobot-hugo@latest

CLI

gobot-hugo comes with a bin shortcut for CLI usage.

hugo [options]

Hugo (https://gohugo.io/) runner for Gobot (https://github.com/benallfree/gobot)

Options

API

Full API docs

Quirks

Extended Edition

Hugo is available in two editions: standard and extended. With the extended edition you can (a) encode to the WebP format when processing images, and (b) transpile Sass to CSS using the embedded LibSass transpiler. The extended edition is not required to use the Dart Sass transpiler.

Hugo Extended is selected by default when available.

If you'll be using the SCSS features of Hugo Extended, it's probably smart to install postcss, postcss-cli, and autoprefixer as devDependencies too, since they can be conveniently called via built-in Hugo pipes:

npm install postcss postcss-cli autoprefixer --save-dev
# or...
yarn add postcss postcss-cli autoprefixer --dev

Sample project

View the Hugo sample project on github.

Try Gobot's other apps

Gobot has a growing list (currently 52) of official apps. Have you tried them all?

Getting Help

Join our Discord community.

Why?

If you are writing a nodejs application that depends upon binaries being present (like PocketHost does), you can add this package as a dependency and execute the binary via CLI or programmatically. This package will make sure your desired external binaries are always available.

If you just want to grab a binary quickly for your own use, npx gobot@latest <app> is quite a bit easier than manually downloading zips and installing binaries in shell paths. Gobot handles it all for you effortlessly.

Adding your app to the Gobot registry

We want to add native support for lots of binary apps!

If you use publish statically linked binary releases on github, you are already 98% compatible with Gobot. In fact, Gobot may already know how to work with it.

To see what initial support looks like:

npx gobot inspect <user>/<repo>

This will index all the releases from your repo and show you exactly what Gobot sees.

If you see everything you expect, you're golden. If things are missing, it may mean some custom programming. Either way, jump on Discord and let us know your results.

If you have the flexibility or are starting a new project, make sure your release names follows these rules:

• Ends in .zip, .tgz, .tar.gz, .bz2
• Include the version (semver recommended)
• Include the platform (freebsd, darwin, linux, win32)
• Include the architecture (arm64, x64, ia32, arm)

Note: GoReleaser is a great option if you're publish a Go-based project.

Contributing

We could use help testing and making sure this works across lots of platforms.

To test a build locally:

pnpm test

All known releases

gobot-hugo versions mirror hugo versions. Gobot knows about 261 releases of hugo: