Getting Started
A short overview of the project, core directories, common commands, and the config areas most people need first.
Project Documentation
Foundry.
Foundry is a Markdown-first CMS written in Go. Here you can find the project docs, the
CLI contract, and the latest HTML coverage report generated from main.
Documentation
Overview, setup guidance, and the main reference links.
Coverage
Current raw Go coverage numbers.
Contract
The CLI contract.
What this site contains
All the documentation you'll need to deploy Foundry, create new plugins, themes, and more.
Architecture
A practical map of the runtime flow and the packages that matter most when you start reading or changing the code.
Configuration
A full reference for content/config/site.yaml, including every config
group, every supported key, and how each setting is used.
JavaScript SDKs
The official Admin SDK and Frontend SDK, their capability model, public API surfaces, and example usage.
Plugin Authoring
How to build a plugin, define metadata, register hooks, sync generated imports, and validate the result.
Theme Authoring
How to scaffold a theme, structure layouts and partials, satisfy the slot contract, and validate the finished package.
CLI Contract
The CLI UX contract, including command wording, output conventions, validation scope, and mutation guidance.
Coverage Report
The HTML coverage report is generated on pushes to main and published
into this site by CI.
Foundry At A Glance
Markdown-first content
Pages and posts live in files with frontmatter, version cleanly in Git, and can be extended with taxonomies, fields, and language-aware routing.
Theme and plugin system
Rendering lives in themes and extension logic lives in plugins, with explicit hook points, a validated slot contract, and generated plugin registration.
Official JavaScript SDKs
Admin frontends, future React admin implementations, plugin UIs, and JS-powered themes can target stable Foundry SDKs instead of private fetch logic.
Dependency-aware rebuilds
The dependency graph tracks taxonomy outputs as well as document outputs, which improves incremental rebuild targeting.
Admin and preview guardrails
The admin surface supports filesystem-backed users, idle-expiring browser sessions, themeable admin UI assets, structured frontmatter editing, restore-preview workflows, audit logs, a command palette, a runtime/debug dashboard with authenticated pprof access, raw HTML handling that stays config-controlled, and preview/admin serving with explicit timeouts.