Building and editing these docs
This site is static HTML built from Markdown. How to write, build, retake screenshots, find what changed in the code, and cut versions.
The site lives in the workspace's docs/ folder. npm run build turns the Markdown into static HTML (dist/) that any static host can serve. Fonts and the search index ship with it, so it works on closed networks too.
Folders
| Path | What |
|---|---|
content/<lang>/<product>/<page>.md |
Sources. Languages ko and en; products home (these family pages), galpi, mothership, naru, golden-image |
nav.yaml |
Products (the switcher at the top left) and page order |
sources.yaml |
The commit of each repository these docs were checked against |
versions.yaml |
Docs versions |
shots/<lang>/<product>/<name>-<light|dark>.webp |
Screenshots |
theme/ |
The page frame (layout.mjs), styles, script, drawn with Galpi's design values |
scripts/ |
Build, preview server, screenshots, drift report, version cut |
Writing
---
title: Page title
nav_title: Short name for the list (optional)
description: One or two sentences under the title
sources: # what the page relies on (used by the drift report)
- galpi:docs/설치와-설정.md
- galpi:apps/server/src/config.ts
keywords: [how to install, deploy] # words people search with that the page may not say (searched, never shown)
---
Plain Markdown. Link other pages without a language, as /galpi/install/.

::: tip Title (optional)
note, tip, warning, danger boxes
:::
::: steps
1. Numbered steps
:::
- Site links get the language and version added, and the build fails on links to pages that don't exist.
- A
shot:image uses the page language's screenshot, falls back to the other language's, then to a placeholder. With both light and dark it follows the theme. - Files at the same path in the two languages are translations of each other; change both.
- When search (Pagefind) finds nothing as typed, it tries again by the rules of Galpi's chat search: Korean particles and endings off, asking words such as "how" out, then one word fewer at a time from the right (
theme/assets/site.js). Give a pagekeywords:when people look for it with words it doesn't say.
Build and preview
cd docs
npm install
npm run build # dist/ + the search index (Pagefind)
npm run serve # http://localhost:4321
npm run dev # rebuild on every change (the search index only on build)
dist/ works at any path (all links are relative), and includes a 404.html.
Retaking screenshots
npm run screenshots captures fixed screens from the running apps in both languages and both themes. What to open and press on each screen is in scripts/screenshots/scenarios/<product>.mjs; buttons are named in Korean and found on English screens through the app's own translation table (i18n-en.ts).
npm run screenshots # everything
npm run screenshots -- galpi --lang ko --theme light # a subset
npm run screenshots -- mothership --only app,catalog
App addresses, who signs in, and the server logs sign-in codes are read from come from the environment or docs/.secrets.local.env (never committed): GALPI_URL, GALPI_LOGIN_CODE, MOTHERSHIP_URL, MOTHERSHIP_LOG, NARU_URL, NARU_LOG and so on. How the demo data is made is in docs/README.md.
When the code changes
npm run drift # what changed since the checked commits, and pages to re-check
npm run drift -- galpi --stat
A page is listed when a file or folder in its sources: changed. After re-checking, update the commit and date in sources.yaml. sources: is used only for this report; it never shows on the page.
Versions
There is one version (the latest) for now. When it's time to split:
npm run version:cut -- 2026.11 "November 2026"
This freezes content/, nav.yaml and sources.yaml into versions/2026.11/ and adds it to versions.yaml. The latest stays at /, the frozen version is served at /v/2026.11/, and with two or more versions a version picker appears at the bottom left. Older versions show a bar linking to the latest; search covers the latest only.