Guides
Guides
- Themes - the built-in themes, and how to write your own
- Icons - emoji, or a named icon from one of eight bundled libraries, on any page/nav entry
- Search - how the static search index works
- Deployment -
bxSites deploy to S3, Azure, GCS, Firebase, FTP/SFTP, rsync, Netlify, Vercel, Cloudflare Pages, or GitHub Pages
- Markdown Extensions - admonitions, footnotes, definition lists and Mermaid diagrams
- Content Blocks - GitBook-style blocks: expandables, cards, columns, a stepper, buttons, and reusable content includes
- Tables - GFM pipe tables, always on, with an automatic responsive-scroll/sticky-header treatment
- OpenAPI / Swagger - an interactive Swagger UI widget for an OpenAPI/Swagger spec, full reference or one operation inline
- Responsive Images - automatic resizing, WebP variants, and CSS/JS bundling, on by default
- Interactivity with Alpine.js - reactive content (copy buttons, live filters, and more) with no extra setup
- Blog - a by-convention blog: posts, authors, categories, archives, RSS, and stats
- Variables & Magic Functions - reusable
{{ variables }} and BoxLang helper functions, usable anywhere in your content
- Plugins - extending BxSites with a BoxLang module of your own
- CLI Providers - registering your own
bxSites <verb> commands from a module
- AI Agent Skills - give Claude Code, Cursor, and other AI coding assistants deep knowledge of bx-sites via the official skill pack
- Importing a theme - best-effort convert an mkdocs/jekyll/hugo theme into a bx-sites theme
- Versioning - snapshot a release's docs and get a version switcher for free
- Internationalization (i18n) - translating your docs into other languages
- Migrating from GitBook - convert a GitBook export into a bx-sites project with one command
- Migrating from mkdocs - convert an mkdocs project into a bx-sites project with one command