Project Name

Configuration

Mon, 01 Jan 0001 00:00:00 +0000

Replace this small table with the public configuration surface of your project.

Key	Type	Default	Meaning
`listen`	string	`127.0.0.1:8080`	Address used by the local server
`log_level`	string	`info`	Minimum emitted log level
`read_only`	boolean	`false`	Disable operations that change state

Example

listen: 0.0.0.0:8080
log_level: debug
read_only: true

Document validation and precedence beside the keys, not in a separate hidden guide.

Make Your First Change

Mon, 01 Jan 0001 00:00:00 +0000

This sample tutorial models a complete task: prepare, change, verify, and review.

Start from a known state

git status --short
git switch -c docs/first-change

Change one thing

Edit a visible string or a small configuration value. Keep the first task narrow enough that its result is obvious.

Verify

Run the project’s smallest relevant check, then open the changed surface and inspect it yourself.

Preview the Site

Mon, 01 Jan 0001 00:00:00 +0000

OINK Starter is a Hugo Module site. Git downloads the source, Go resolves the pinned theme, and Hugo builds everything.

Prerequisites

Install Git, Go 1.27 or newer, and Hugo Extended 0.165.0 or newer. The word extended must appear in hugo version.

Three commands

git clone https://github.com/pgsty/oink-starter.git
cd oink-starter
hugo server

Open http://localhost:1313/. Chinese is under /zh/; French is under /fr/.

Project Overview

Mon, 01 Jan 0001 00:00:00 +0000

Replace this page with the shortest useful explanation of your project.

The problem

Describe the problem in the reader’s language. Avoid implementation details until the reader understands why the project matters.

The outcome

Explain what a successful user can do after adopting the project.

Tip

A strong overview helps readers decide whether to continue in less than two minutes.

Requirements

Mon, 01 Jan 0001 00:00:00 +0000

Keep prerequisites short, exact, and testable.

Tools

A supported operating system.
Git for retrieving the source.
The runtime version required by your project.

Verify

Give readers one command per prerequisite:

$ project --version
project 0.1.0

Replace the placeholder command with your own before publishing.

Add a Documentation Page

Mon, 01 Jan 0001 00:00:00 +0000

In OINK, the content tree is the documentation sidebar. A new Markdown file becomes a new page.

Create the file

---
title: New capability
description: What the capability does.
weight: 30
---

Explain the capability here.

Save it as content/docs/reference/new-capability.md.

Add translations

Create new-capability.zh.md and new-capability.fr.md beside it. Keep explicit heading IDs aligned across languages.

Architecture

Mon, 01 Jan 0001 00:00:00 +0000

Document the few components a contributor must understand before making a change.

System map

Part	Responsibility
Interface	Accepts user input and presents results
Core	Applies the project’s rules
Adapters	Connect external systems

Boundaries

Name what the project deliberately does not own. Clear boundaries prevent documentation from promising more than the software provides.

Command Reference

Mon, 01 Jan 0001 00:00:00 +0000

`project start`

Starts the local service.

project start [--config FILE] [--listen ADDRESS]

`project check`

Validates configuration without starting the service. Exit status 0 means valid; any non-zero status means the configuration must not be deployed.

project check [--config FILE]

Replace these placeholders with commands copied from your real CLI help output.

Installation

Mon, 01 Jan 0001 00:00:00 +0000

Show the shortest supported installation path first.

Install

git clone https://github.com/OWNER/PROJECT.git
cd PROJECT
./project start

Confirm the result

Tell readers exactly what success looks like: a URL to open, a message to see, or a command whose exit status is zero.

Important

Replace every uppercase placeholder before publishing your project documentation.

Understand the Structure

Mon, 01 Jan 0001 00:00:00 +0000

The starter keeps each responsibility in one obvious place.

The map

hugo.yaml site identity, languages, and optional integrations
data/home/ one compact landing-page file per language
content/blog/ posts, design notes, and releases
content/docs/ the four-part documentation tree
content/book/ this sequential tutorial
.github/workflows/ GitHub Pages and Cloudflare Pages deployment

The menus.main front matter on each section root creates the top navigation and its dropdowns. The directory tree below Docs and Book creates their sidebars.

Make It Yours

Mon, 01 Jan 0001 00:00:00 +0000

Most projects need only content changes and two configuration edits.

Change identity once

At the top of hugo.yaml, replace Project Name and https://example.org/. The YAML title anchor carries the name into all three languages.

Replace assets/icons/logo.svg and static/favicon.svg only when you have real project artwork.

Replace the home page

Edit data/home/en.yaml, zh.yaml, and fr.yaml. The sections list controls order; the named blocks below it provide the copy.

Publish the Site

Mon, 01 Jan 0001 00:00:00 +0000

The generated public/ directory is a static site. The repository includes two independent deployment paths.

GitHub Pages

In repository settings, choose Pages → Source → GitHub Actions. A push to main runs .github/workflows/github-pages.yaml; the workflow calculates the correct repository subpath automatically.

Cloudflare Pages

Create a Direct Upload Pages project, then add CLOUDFLARE_ACCOUNT_ID and CLOUDFLARE_API_TOKEN as repository secrets. Set the repository variable CLOUDFLARE_PAGES_ENABLED to true for automatic deploys. The project name defaults to the repository name and can be overridden with CLOUDFLARE_PROJECT_NAME.

Welcome to the project blog

Thu, 15 Jan 2026 00:00:00 +0000

Use the Post section for news, explanations, and stories that do not belong in the reference documentation.

What to publish here

Write for readers who want context: why the project exists, what the team learned, and what comes next.

Replace this page

Keep the front matter, change the title and date, then write your first real post below it.

A small content model that can grow

Sat, 10 Jan 2026 00:00:00 +0000

This starter gives each kind of writing one obvious home. The separation keeps navigation predictable without locking the project into a large taxonomy.

Three reading modes

Blog posts explain change over time.
Docs answer focused questions.
The Book teaches an ordered workflow.

Add structure only when needed

Start with the supplied sections. Add a new branch only when readers need a distinct route through the material.

Project 0.1.0

Thu, 01 Jan 2026 00:00:00 +0000

Version 0.1.0 establishes the project’s first usable baseline.

Highlights

A documented installation path.
A small, stable public surface.
A clear place to report problems.

Upgrade notes

This is the first release, so there is no earlier version to migrate.

Project Name

Configuration

Example

Make Your First Change

Start from a known state

Change one thing

Verify

Preview the Site

Prerequisites

Three commands

Project Overview

The problem

The outcome

Requirements

Tools

Verify

Add a Documentation Page

Create the file

Add translations

Architecture

System map

Boundaries

Command Reference

project start

project check

Installation

Install

Confirm the result

Understand the Structure

The map

Navigation follows content

Make It Yours

Change identity once

Replace the home page

Publish the Site

GitHub Pages

Cloudflare Pages

Welcome to the project blog

What to publish here

Replace this page

A small content model that can grow

Three reading modes

Add structure only when needed

Project 0.1.0

Highlights

Upgrade notes

`project start`

`project check`