Skip to content

Repository files navigation

notes

Personal engineering notes. Markdown in notes/ owns the content, public/theme.css owns the presentation, and public/favicon.svg owns the logo. inkpath generates the static site.

pnpm install
pnpm dev

Saving Markdown, the stylesheet, or another public asset rebuilds the site and refreshes the preview.

Use pnpm verify before committing. YAML frontmatter is the catalog: identifier is an optional short label, order controls the rendered sequence, and slug controls the clean URL. Directory and filename prefixes organize the source tree but do not override an explicit frontmatter order.

The theme hides metadata beneath page headings and inside collection and note listings. Set theme.showPageDetails and theme.showListDetails independently in inkpath.yaml when a site should expose one without the other.

For a private publication preflight, set NOTES_RELEASE_DENYLIST to newline-separated literal terms before running pnpm verify.

notes/INDEX.md is the site home, and each collection uses its own INDEX.md as the overview. Other Markdown files are individual notes. The repository-level README.md is only the GitHub project description.

About

Personal notes on software systems, infrastructure, AI inference, and agent engineering.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages