Home
Point BxSites at a docs/ folder (or src/, for a project that isn't really "docs" in spirit). Get a fast, themeable static site out - documentation, a marketing site, a blog, or anything else Markdown can express - complete with search, i18n, and a markdown toolkit built for real content.
This very site is built by BxSites, from the Markdown files in this
repository's own docs/ folder.
BxSites isn't only for reference documentation - it's a general-purpose
static site generator. A marketing site, a blog, a knowledge base, a
product site, a personal site: anything you can write in Markdown builds
the same way, through the same themes, search, and i18n. Content lives in
docs/ by default, or src/ for a project that reads more like a website
than "docs" - every command works the same either way.
Point it at a docs/ folder - or src/, if your project reads more like
a website than "docs" - and it renders a complete site into site/, no
server required to host it.
Nest folders and files under docs/ (or src/) and the navigation builds
itself, in the order you set via frontmatter.
A full gallery - bootstrap, material, tailwind, and seven more inspired
by Docsy, Stripe, Docusaurus, Just the Docs, VuePress, GitBook and Notion -
all overridable with your own theme.
A MiniSearch-powered search box (fuzzy matching, prefix search) plus a
Cmd/Ctrl+K command palette, wired against a search index built at build
time - no server dependency.
Drop posts under docs/blog/posts/ and get authors, categories, year
archives, RSS feeds, and per-post featured images - zero config required.
Fingerprinted CSS/JS bundling and responsive images out of the box, plus Bootstrap, highlight.js, Alpine.js, MiniSearch and (opt-in) Mermaid all vendored - a built site needs zero outbound requests by default.
A plugin is just another installed BoxLang module - no separate plugin API to learn.
install:plugin and install:theme download a published package straight
into your project - browse bxsites-plugins and bxsites-themes on
ForgeBox.
theme:import --source=mkdocs|jekyll|hugo converts another generator's own
theme templates into a bx-sites scaffold to build on, instead of starting
from scratch.
bxSites migrate --from=gitbook|mkdocs|markdown-zip|notion converts an
existing export or project into a working bx-sites project in one command.
bxSites deploy ships the built site straight to S3, Azure, GCS, Firebase,
FTP/SFTP, rsync, Netlify, Vercel, Cloudflare Pages, or GitHub Pages - or
bxSites package zips it into a single archive instead.
{{ dotted.path }} pulls from bxsites.yaml's own variables block;
{{ $name(args) }} calls a small BoxLang helper straight from Markdown -
no plugin, no wiring.
Tables, buttons, prompts, expandables, tabs, and embedded OpenAPI specs - a GitBook-style block library on top of plain Markdown.
See it, don't just read about it
BxSites' own Markdown toolkit, in action right here on the homepage - not a screenshot, the real thing:
install-bx-module bx-sites
bxSites new
bxSites serve
Twelve canonical admonition types - note, tip, warning, danger
and more - each with its own accent color, plus a ??? collapsible
variant. See Markdown Extensions.
Grouped code tabs, KaTeX math, Mermaid diagrams, footnotes and definition lists all ship out of the box - see Markdown Extensions.
Where to go next
Install, scaffold a project, and build and serve it.
Every verb and its options.
The full bxsites.yaml reference.
Admonitions, tabs, cards, callouts, math and Mermaid diagrams.
Posts, authors, categories, archives, RSS, drafts, and a stats page.
Automatic image resizing/WebP, and fingerprinted CSS/JS bundling.
deploy/package, and the built-in GitHub Actions workflow.
Versioning policy and what's new per release.
Need a hand building your site?
BxSites is free and open source - but if you'd rather have the team who builds it do the work, Ortus Solutions offers professional services and consulting for documentation sites, migrations, and any other static site built with BxSites.