This documentation website is built using Docusaurus 3, a modern static website generator.
$ npm install
$ npm start
This command starts a local development server (on port 3001) and opens up a browser window. Most changes are reflected live without having to restart the server.
$ npm run build
This command generates static content into the build directory and can be served using any static contents hosting service.
We use Algolia to power search. This is done using a Docusaurus plugin. Changelogs are explicitly excluded from the index so as to not bloat the search experience with potentially conflicting information.
Our changelogs at docs.tramline.app/changelog are powered by a custom Docusaurus plugin. While most edge cases are handled automatically, here are some important points to remember when writing changelogs:
- Ignore version numbers in titles - the parser only reads dates in parentheses
- We increment patch versions only to satisfy the parser
- Non-highlight improvements and fixes must use
<details>tags - Always include a
<summary>tag to avoid the default "Details" text - End each changelog with the
<endcommiters/>tag - The
### Committerssection populates author icons but is removed from the final output
- Image paths are relative to
$ROOT/changelog/*.md - Example: When in
$ROOT/changelog/foo.md, reference images from there
- If the output looks incorrect, simply delete
$ROOT/changelog - The directory will automatically regenerate from
CHANGELOG.md