Click the Castor logo or press Ctrl Alt T to change theme.
# The generate command The primary command is `generate`: ```bash castor-docs generate --source=.dev/docs --target=.dev/docs-dist ``` ## Options | Option | Default | Description | | --- | --- | --- | | `--source` | `.dev/docs` | Directory containing documentation source files. | | `--target` | `.dev/docs-dist` | Directory replaced with generated static HTML. | ## Output model Generation replaces the target directory each time. Keep `.dev/docs-dist` ignored and let CI build it when publishing documentation. Every page embeds the Markdown source safely as JSON. The browser then renders Markdown, sanitizes the HTML, highlights code, and loads the search index. ## Safety The generator refuses unsafe targets such as the project root or a target inside the source directory.
Castor ecosystem