# bongo

> A static site generator built on Rolldown and LightningCSS.

bongo turns Markdown, templates, and assets into static HTML. Each page below links to its Markdown copy.

## Start
- [Introduction](https://bongo.build/intro.md): What bongo is, what it does, which packages it ships, and which runtimes it supports.
- [Quick start](https://bongo.build/quick-start.md): Create a bongo site with create-bongo, or add bongo to a project by hand, then run the dev server and build the site.
- [Project layout](https://bongo.build/project.md): The folders of a bongo project, what bongo does with each one, and the steps of a build.
- [CLI](https://bongo.build/cli.md): The bongo build and bongo dev commands, their options, debug logs, the output folder rules, incremental builds, and minification.
- [Benchmarks](https://bongo.build/benchmarks.md): How fast bongo builds a site of 10,000 Markdown pages, after each kind of edit and in bongo dev, and how it compares with Astro.

## Guides
- [Content](https://bongo.build/content.md): How bongo turns the files in content/ into pages, how page URLs, sections, tags, and drafts work, and how .hbs content compiles.
- [Frontmatter](https://bongo.build/frontmatter.md): The YAML subset that bongo reads at the top of content files, how it types values, and how to update a site from string-only frontmatter.
- [Templates](https://bongo.build/templates.md): Template syntax, how bongo finds the layouts of a page, the variables that templates read and declare, and the special elements that add scripts, styles, and assets.
- [Partials](https://bongo.build/partials.md): How to write partials as Handlebars files, modules, or config functions, and how to call them from templates, Markdown, and loaders.
- [Data](https://bongo.build/data.md): How to put JSON, YAML, and module files in data/ and read them in every template as $data.
- [Images](https://bongo.build/images.md): How bongo resizes and converts images with Bun.Image, the bongo:image element, content images, the image cache, and the $images config.
- [Dynamic images](https://bongo.build/dynamic-images.md): How $assets.render draws a partial as an SVG, PNG, JPEG, or WebP image from your page data, and which runtimes each format needs.
- [Open Graph images](https://bongo.build/open-graph-images.md): Give each page its own social card with $assets.render, the Open Graph and X meta tags, and a frontmatter image that replaces the card.
- [CSS](https://bongo.build/css.md): How bongo builds CSS with LightningCSS, including CSS modules, packages in @import, and files in url().
- [Output files](https://bongo.build/output-files.md): How a .hbs file in content/ with a second extension becomes an output file, such as a sitemap, a robots.txt, or a feed.
- [Data modules](https://bongo.build/data-modules.md): How a .json.ts or .json.js file in content/ runs at build time and writes its default export as a JSON file.
- [Markdown copies](https://bongo.build/markdown-copies.md): How bongo writes a Markdown copy of each page for AI tools, and how to add Copy page and View as Markdown buttons.
- [Alternates](https://bongo.build/alternates.md): How <bongo:alternate> links other versions of a page, such as a Markdown copy, a feed, or a translation, and how output files and data modules list them.
- [Create an llms.txt](https://bongo.build/llms-txt.md): How to write an /llms.txt file that lists the Markdown copy of each page, for AI tools.
- [Translations](https://bongo.build/translations.md): How to build a site in more than one language, with a page for each language, hreflang links, the lang of each page, translated layout text, and a sitemap.

## Runtime
- [Client runtime](https://bongo.build/client-runtime.md): How bongo/client turns a static site into a client-navigated SPA, with its options, events, programmatic navigation, stylesheet handling, and scroll restoration.
- [View transitions](https://bongo.build/view-transitions.md): How to name and animate elements across page navigations with transition attributes and the transition presets of the client runtime.
- [Dev server](https://bongo.build/dev-server.md): How bongo dev serves the site, what it rebuilds on each change, how it handles errors and missing pages, and how it reloads the browser.

## Reference
- [Config](https://bongo.build/config.md): The fields of bongo.config.ts, how plugins merge into the config, and how publicPath comes from $site.url.
- [Variables](https://bongo.build/variables.md): The values that templates read, such as $page, $pages, and $site, with an example of what each one holds.
- [Special elements](https://bongo.build/special-elements.md): Each <bongo:*> element, its attributes, and the HTML that bongo writes in its place.
- [Utilities](https://bongo.build/utilities.md): The helper functions that bongo gives every template as $utils, with example values, and how to add your own.
- [Hooks](https://bongo.build/hooks.md): How $hooks.transform changes each page and output file after it renders and before bongo writes it.
- [Loaders](https://bongo.build/loaders.md): How loaders in $loaders transform content files by extension, how bongo chains them, and the utilities that each loader gets.
- [TypeScript](https://bongo.build/typescript.md): The JSX types that bongo ships for its elements and attributes, and the types it exports for the config, loaders, hooks, and data modules.

## Plugins
- [@bongo/markdown](https://bongo.build/markdown.md): The Markdown loader plugin for bongo, its partial elements, its md4x options, and its syntax highlighters.
- [@bongo/feed](https://bongo.build/feed.md): The RSS and Atom feed plugin for bongo, its feed:link, feed:channel, and feed:item elements, and its errors.