Ferret Website

Built with Hugo

Prerequisites

• Go
• Hugo
• Node.js
• Mage for building the website.
• frep(optional) is the tool used for templating the documentation

Getting Started

Installing dependencies

go mod tidy && mage install

Dev server

mage serve

The standard development server does not generate the Pagefind search bundle.

Production build

Build the static site and its client-side search index:

mage build

The generated site, including Pagefind assets under public/pagefind/, is written to public/.

Search preview

Build the site and search index, then serve the generated static output with Pagefind's preview server:

mage serveSearch

Generating API docs

Generating stdlib documentation requires doc rep YAML.

mage generate

Publishing

mage publish