BxSites

BoxLang module · zero runtime dependencies

Markdown in.
A blazing‑fast site out.

bxSites turns a folder of Markdown into a themed, searchable, static site — docs, blogs, marketing pages, knowledge bases. No JS build step. No server to run. Just files, fast.

Get Started → Star on GitHub

$install-bx-module bx-sites

search index built · 42ms

yourproject.dev/docs

Overview

Install

Theming

Deploy

bxSites newbxSites serve

0 outbound requests · air‑gapped

The pipeline

Markdown in. Everything else, handled.

Markdown

Render

Index + AI

Deploy

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.

Everything included

One tool, the whole pipeline.

From folder structure to a deployed URL — theming, search, i18n, blog, and shipping are already wired in.

Markdown in, static HTML out

Point it at a docs|src/ folder and it renders a complete site into site/, no server required to host it.

Folder structure is nav structure

Nest folders and files under docs/ and the navigation builds itself, in the order you set via frontmatter.

Ten built-in themes

A full gallery — bootstrap, material, tailwind, and seven more — all overridable with your own theme.

Static, client-side search

A MiniSearch-powered search box plus a Cmd/Ctrl+K command palette, wired against a search index built at build time.

A blog, out of the box

Drop posts under docs/blog/posts/ and get authors, categories, year archives, RSS feeds, and featured images — zero config.

Fast, air-gapped by default

Bootstrap, highlight.js, Alpine.js, MiniSearch and (opt-in) Mermaid all vendored — a built site needs zero outbound requests.

A real plugin system

A plugin is just another installed BoxLang module — no separate plugin API to learn.

Ship it anywhere

bxSites deploy ships to S3, Azure, GCS, Firebase, FTP/SFTP, rsync, Netlify, Vercel, Cloudflare Pages, or GitHub Pages.

Versions & i18n

Multiple doc versions and translated trees, both nav-aware out of the box.

Reusable variables & magic functions

{{ dotted.path }} pulls from bxsites.yaml's own variables block — no plugin, no wiring.

Rich content blocks

Tables, buttons, prompts, expandables, tabs, and embedded OpenAPI specs — a GitBook-style block library on top of plain Markdown.

Import an existing theme

theme:import --source=mkdocs|jekyll|hugo converts another generator's own templates into a bx-sites scaffold.

Built for the agentic web

Docs your AI assistant can actually use.

Every build ships machine‑readable context alongside the human‑readable site — so agents answer from the real docs, not a guess.

Works with

bxSites build --mcp

✓ Rendering pages…

✓ Writing llms.txt (agent-ready context)

✓ Generating mcp-manifest.json

✓ Search index built

llms.txt, automatically

Every build emits a spec‑compliant llms.txt — clean, structured context, no scraping required.

Built‑in MCP support*

Set mcp: true to generate an MCP-ready manifest *host it live with bxSites Cloud and your docs become a queryable server.

Copy as Markdown, or open in ChatGPT / Claude

Every page ships a page‑action menu — copy the raw Markdown, open the page in ChatGPT or Claude, or copy a direct link.

`:::prompt:::` blocks

Write agent‑only instructions inline — visible to AI readers, invisible on the rendered page.

Official Agent Skills pack

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.

Already in your build

Docs as a build step, not another toolchain.

Java 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.

Works with

Scan controllers

OpenAPI

Javadoc / DocBox

bxSitesBuild

Gradle plugin

Run ./gradlew bxSitesBuild alongside your normal build — docs regenerate on every CI run.

Maven plugin

Bind bxsites-maven-plugin to the package phase — mvn install ships docs with the artifact.

Spring Boot / ColdBox

Point bxSites at a Spring Boot or ColdBox app and it scans your REST endpoints and OpenAPI spec into browsable reference docs.

Javadoc & DocBox, ingested

Point bxSites at your Javadoc or a ColdBox app via DocBox — reference pages generate themselves.

$./gradlew bxSitesBuild|mvn bxsites:build

How we compare

Built differently, on purpose.

Not a JS framework with a docs mode bolted on — a docs generator written for the JVM from day one.

	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	✓	✓	✓	✓	✓