inkssg

A small static site generator in Go. No node, no plugins, no config required.

What is inkssg?

A small site doesn't need a node toolchain, a webpack config, and twenty dependencies. inkssg started as a single main.go powering a personal site. Now it's a Go library and a CLI you can drop into any small project: a landing page, a bio, a few pages of docs.

If you need blog collections, i18n, or a plugin ecosystem, use Hugo or Astro. inkssg stays small on purpose.

• Markdown for prose, raw HTML when you want full control
• Frontmatter for page metadata, ink.yaml for site-wide data
• Built-in themes you can override with your own
• Single assets/ directory
• Works as a CLI or a Go library

Install

go install github.com/snowztech/inkssg/cmd/inkssg@latest

Or grab a binary from Releases.

Quick start

inkssg new my-site
inkssg build my-site

Output goes to my-site/public/. Preview locally:

python3 -m http.server --directory my-site/public

Then open http://localhost:8000.

To change the page, edit my-site/pages/index/content.md and run inkssg build my-site again.

Use as a library

go get github.com/snowztech/inkssg

import "github.com/snowztech/inkssg"

inkssg.Build(".") // builds the site in the given directory

See examples/library for a runnable version.

Project layout

my-site/
├── ink.yaml             # optional: site-wide data
├── pages/
│   ├── index/
│   │   └── content.md   # or content.html
│   └── about/
│       └── content.md
├── themes/              # optional: your own themes
│   └── custom/
│       ├── layout.html  # Go template with {{.Content}}
│       ├── styles.css
│       └── script.js
└── assets/              # images, favicons, fonts

Build output goes to public/.

Themes

inkssg ships with three themes: minimal, devtool, and bio. Pick one in ink.yaml:

default_theme: devtool

To use your own theme, drop it in themes/<name>/. A local theme with the same name takes precedence over the built-in.

Page metadata

Frontmatter goes at the top of content.md:

---
title: My Page
description: A short blurb
---

# Hello

Content here.

Add theme: devtool to use a different theme on one page.

Site config

ink.yaml holds data shared across pages. Optional.

name: My Site
meta:
  lang: en
  description: Site description
links:
  - name: GitHub
    url: https://github.com/user

More

Full docs · Examples · Principles · Roadmap · MIT