yuanme docs
A static site generator for programmers' and mathematicians' sites, in Markdown and Org, built to be driven by coding agents.
Getting started
- Getting started
- Install yuanme, make a Site with one Post, check it and build it.
- Deploying
- What yuanme build writes, the Host adapter for each static host, the cache policy, headers, redirects and the 404 Page.
Guides
- Collections and fields
- Collections and their Entries, the fields every Entry has and the ones a Collection declares, Slugs, Taxonomies, Data files, and yuanme new.
- Markdown
- The Markdown yuanme reads: CommonMark with GFM, heading ids and Labels, links between Entries, raw HTML, code blocks and ::: blocks.
- The Org subset
- How an Org file becomes an Entry, which Org yuanme renders, what it rejects or warns about, and where it differs from Emacs.
- Math and Theorem blocks
- LaTeX math in Markdown and Org, rendered to MathML at build time, with numbered equations, Labels, references and macros.
- Templates
- The Jinja files that make each Page, what each kind of Route sees, the filters yuanme adds, Layouts and Partials, and what check finds in them.
- Components
- Reusable pieces of Templates with declared props, how to call them, how they differ from Partials, and the Sidecars beside them.
- Styles
- Link stylesheets from a Template; yuanme bundles their imports, runs Tailwind for one that imports it, adds prefixes for your browsers, minifies and hashes them, and copies Static files as they are.
- Scripts
- Load TypeScript or JavaScript modules from a Template; yuanme bundles them, with packages from node_modules, into minified and hashed chunks.
- Images
- How Entry bodies name images, what yuanme makes of them, the image field type, and the [images] settings.
- Budgets
- The Site budgets yuanme build measures every Page against, how to change them, strict mode, and the build report.
Reference
- Site config
- yuanme.toml, the one file that declares the Site, with every key it takes.
- The CLI
- Every command and flag, the exit codes, and the JSON that —json prints.
- Diagnostic codes
- Each error and warning yuanme reports, with an example and its fix.