bxSites turns Markdown into fast, themed, searchable sites that AI agents can read, write and query. Docs, blogs, marketing pages, knowledge bases. Host it anywhere, or on bxSites Cloud.
One build step: your Markdown source, rendered through the theme, indexed for search, packaged as AI-ready context, and shipped — every pass, automatically in sync.
docs/ ├── index.md ├── guides/ └── blog/posts/
Every build ships machine‑readable context alongside the human‑readable site, so agents answer from your real content, not a guess.
Every build emits a spec‑compliant llms.txt — clean, structured context, no scraping required.
Set mcp: true to generate an MCP-ready manifest *host it live with bxSites Cloud and your site becomes a queryable server.
Every page ships a page‑action menu — copy the raw Markdown, open the page in ChatGPT or Claude, or copy a direct link.
:::prompt::: blocksWrite agent‑only instructions inline — visible to AI readers, invisible on the rendered page.
Drop bx-sites-skills into Claude Code, Cursor, or any MCP-aware agent — pre-built skills for scaffolding, theming, and content that know bxSites inside out.
Publish with one command, then add the parts a static site can't do on its own: forms, comments, managed content and a live MCP server for AI agents.
cloud: siteId: "your-site-uuid" apiUrl: "https://cloud.bxsites.app" comments: true
$ export BXSITES_CLOUD_TOKEN=cb_... $ bxSites publish
publishShip site/ to your Cloud site over its publish API.
Drop in a contact-form block. Spam filtering and notifications are set up in Cloud.
A comments block puts a thread on any page.
Edit blocks in the Cloud portal and bake them into your pages at build time.
Set mcp: true and Cloud serves your published site to AI agents, read-only.
Forms, comments, managed content and the MCP server depend on your Cloud plan. Deploying anywhere else stays fully supported.
From folder structure to a deployed URL — theming, search, i18n, blog, and shipping are already wired in.
Point it at a docs|src/ 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.
A full gallery — bootstrap, material, tailwind, and seven more — all overridable with your own theme.
A MiniSearch-powered search box plus a Cmd/Ctrl+K command palette, wired against a search index built at build time.
Drop posts under docs/blog/posts/ and get authors, categories, year archives, RSS feeds, and featured images — zero config.
Bootstrap, highlight.js, Alpine.js, MiniSearch and (opt-in) Mermaid all vendored — a built site needs zero outbound requests.
A plugin is just another installed BoxLang module — no separate plugin API to learn.
bxSites deploy ships to S3, Azure, GCS, Firebase, FTP/SFTP, rsync, Netlify, Vercel, Cloudflare Pages, or GitHub Pages.
Multiple doc versions and translated trees, both nav-aware out of the box.
{{ dotted.path }} pulls from bxsites.yaml's own variables block — no plugin, no wiring.
Tables, buttons, prompts, expandables, tabs, and embedded OpenAPI specs — a GitBook-style block library on top of plain Markdown.
theme:import --source=mkdocs|jekyll|hugo converts another generator's own templates into a bx-sites scaffold.
Keep the theme and its updates. Drop a layout, a slot or an asset next to your docs and bxSites layers it on top. How overrides work →
docs/
└── .overrides/
└── bootstrap/
├── home.bxm a layout
├── assets/logo.svg swap an asset
└── slots/
├── announcement-bar.bxm
└── footer.bxm
layouts: - layout: landing match: ["marketing/**", "pricing.md"]
announcement-barempty by defaultheaderthe theme's navbarsidebar-bottomfooterthe theme's footerhead-extra, just before the closing head tagJava or BoxLang shops don't need a Node pipeline bolted on. Generate docs from the build you already run — Gradle, Maven, or a Spring Boot app.
Run ./gradlew bxSitesBuild alongside your normal build — docs regenerate on every CI run.
Bind bxsites-maven-plugin to the package phase — mvn install ships docs with the artifact.
Point bxSites at a Spring Boot or ColdBox app and it scans your REST endpoints and OpenAPI spec into browsable reference docs.
Point bxSites at your Javadoc or a ColdBox app via DocBox — reference pages generate themselves.
Not a JS framework with a docs mode bolted on. A static site generator written for the JVM from day one, with AI and hosting built in.
| bxSites | Docusaurus | VitePress | MkDocs Material | Hugo | |
|---|---|---|---|---|---|
| Native JVM, zero Node.js | ✓ | ✗ | ✗ | ✗ | ✗ |
| Gradle / Maven / Spring Boot build integration | ✓ | ✗ | ✗ | ✗ | ✗ |
| ColdBox & DocBox integration | ✓ | ✗ | ✗ | ✗ | ✗ |
Official bxSites CLI |
✓ | ✗ | ✗ | ✗ | ✗ |
| Official AI Agent Skills pack | ✓ | ✗ | ✗ | ✗ | ✗ |
| *Built-in AI / MCP server | ✓ | ✗ | ✗ | ✗ | ✗ |
| 10 built-in themes | ✓ | 1 | 1 | 1 | ✗ |
| Versioning, zero plugins | ✓ | ✓ | ✗ | ✓ | ✗ |
| i18n, zero plugins | ✓ | ✓ | ✗ | ✓ | ✓ |
| Air-gapped build (0 outbound requests) | ✓ | ✗ | ✗ | ✗ | ✓ |
| Built-in blog, zero plugins | ✓ | ✓ | ✗ | ✗ | ✓ |
| One-command deploy (S3, Netlify, Vercel, Cloudflare, FTP…) | ✓ | ✗ | ✗ | ✗ | ✓ |
| Responsive <picture> + WebP generated from every image | ✓ | ✗ | ✗ | ✗ | ✓ |
| Content-hash fingerprinted assets | ✓ | ✗ | ✗ | ✗ | ✓ |
| CSS/JS bundling + incremental build cache | ✓ | ✗ | ✗ | ✗ | ✓ |
| Sitemap, robots.txt and OG/meta cards generated automatically | ✓ | ✓ | ✓ | ✗ | ✓ |
| Extensible search providers with built-in and custom options | ✓ | ✗ | ✗ | ✗ | ✗ |
| Mermaid diagrams from fenced Markdown (opt-in, vendored) | ✓ | ✓ | ✓ | ✓ | ✓ |
| Rich content blocks: cards, tabs, steps, embeds and reusable includes | ✓ | ✓ | ✓ | ✓ | ✓ |
| Interactive OpenAPI / Swagger embeds from JSON or YAML | ✓ | ✓ | ✓ | ✓ | ✓ |
* Requires a bxSites Cloud plan
A guided, 20-lesson walkthrough from install to a deployed site — the fastest way to learn bx-sites end to end.
Install the module, scaffold a project, and have a themed, searchable site running locally in under a minute. Host it anywhere, or publish it to bxSites Cloud.
Ortus Solutions offers professional support, architecture reviews and custom development, including documentation sites, marketing sites, migrations and anything built with bxSites.
Answers from the team that wrote the runtime.
Themes, plugins, migrations and integrations built to your brief.
Get your team productive and your site setup checked.
