BxSites Getting Started

BxSites (ortus-boxlang/bx-sites) is a BoxLang-based static site generator in the spirit of mkdocs/GitBook: point it at a docs/ (or src/) folder of Markdown and it builds a themed, searchable static site - not just for docs, also blogs/marketing sites/knowledge bases.

Every command runs as bxSites <verb> [options] (or boxlang bxSites <verb> [options] where the PATH shim isn't installed - e.g. a CI runner). Every verb accepts --projectRoot=<path>. CLI flags always use --flag=value, never a bare positional value, for a verb's primary argument.

Prerequisites

BxSites needs the BoxLang runtime plus bx-markdown, bx-esapi, bx-yaml, bx-image (all installed automatically as box.json dependencies):