Click the Castor logo or press Ctrl Alt T to change theme.
# Documentation conventions Castor Docs is intentionally convention-first. Most packages should only need Markdown files plus a small `config.php`. ## File routes | Source file | Output route | | --- | --- | | `.dev/docs/index.md` | `/index.html` | | `.dev/docs/pages/index.md` | `/docs/index.html` | | `.dev/docs/pages/install.md` | `/docs/install.html` | | `.dev/docs/pages/guides/index.md` | `/docs/guides/index.html` | | `.dev/docs/pages/guides/templates.md` | `/docs/guides/templates.html` | `index.md` always means “the index page for this directory”. The top-level `.dev/docs/index.md` remains the site landing page; `.dev/docs/pages/index.md` is the documentation landing page. ## Markdown features Castor Docs sends Markdown to the browser for rendering and sanitization. The theme is designed for headings, paragraphs, inline formatting, links, lists, blockquotes, GitHub-style callouts, fenced code blocks, tables, and horizontal rules. See the [full rendering example](rendering-example.html) for a kitchen-sink page that exercises the supported styling. See [generated site behavior](generated-site.html) for details about search, syntax highlighting, callouts, scroll behavior, version detection, and the footer. ## Page metadata Each page can start with simple front matter: ```md --- description: A short lede used by navigation and search. --- # Page title ``` The first level-one heading is the page title. The `description` value is used as the page lede. If no description is present, the first paragraph is used. ## Related packages The sidebar groups Castor packages into dependencies, dependants, other packages, and abandoned packages. Each group is collapsible independently, and abandoned packages are collapsed by default. Package links come from published Composer metadata, preferring `homepage` and falling back to source information.
Castor ecosystem