Home
Point BX Sites at a docs/ folder. 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 BX Sites, from the Markdown files in this
repository's own docs/ folder.
BX Sites 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.
Point it at a docs/ folder and it renders a complete site into site/ -
no server required to host it.
Nest folders and files under docs/ and the navigation builds itself, in
the order you set via frontmatter.
bootstrap, material and tailwind - all sharing the same BoxLang brand
palette, and all overridable with your own theme.
A lunr.js-powered search box, 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, lunr.js 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.
bxSites migrate --source=... --from=gitbook|mkdocs converts an existing
GitBook export or mkdocs project into a working bx-sites project in one
command.
See it, don't just read about it
BX Sites' 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.json 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.
The built-in GitHub Actions workflow.
Versioning policy and what's new per release.
Need a hand building your site?
BX Sites 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 BX Sites.