https://github.com/tramlinehq/docs
Documentation for Tramline
https://github.com/tramlinehq/docs
documentation docusaurus release-engineering
Last synced: 5 months ago
JSON representation
Documentation for Tramline
- Host: GitHub
- URL: https://github.com/tramlinehq/docs
- Owner: tramlinehq
- License: cc0-1.0
- Created: 2021-12-23T07:26:21.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2026-01-05T07:52:25.000Z (6 months ago)
- Last Synced: 2026-01-13T15:47:20.751Z (5 months ago)
- Topics: documentation, docusaurus, release-engineering
- Language: TypeScript
- Homepage: https://docs.tramline.app
- Size: 53.7 MB
- Stars: 5
- Watchers: 1
- Forks: 1
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Tramline Documentation
[](/LICENSE.md)
[](https://docusaurus.io)
This documentation website is built using [Docusaurus 3](https://docusaurus.io/), a modern static website generator.
### Installation
```
$ npm install
```
### Local Development
```
$ 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.
### Build
```
$ npm run build
```
This command generates static content into the `build` directory and can be served using any static contents hosting service.
### Search Index
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.
### Writing Changelogs
Our changelogs at [docs.tramline.app/changelog](https://docs.tramline.app/changelog) are powered by a [custom Docusaurus plugin](https://github.com/facebook/docusaurus/tree/main/website/src/plugins/changelog). While most edge cases are handled automatically, here are some important points to remember when writing changelogs:
#### Version Numbers
- Ignore version numbers in titles - the parser only reads dates in parentheses
- We increment patch versions only to satisfy the parser
#### Structure
- Non-highlight improvements and fixes must use `` tags
- Always include a `` tag to avoid the default "Details" text
- End each changelog with the `` tag
- The `### Committers` section populates author icons but is removed from the final output
#### Images
- Image paths are relative to `$ROOT/changelog/*.md`
- Example: When in `$ROOT/changelog/foo.md`, reference images from there
#### Troubleshooting
- If the output looks incorrect, simply delete `$ROOT/changelog`
- The directory will automatically regenerate from `CHANGELOG.md`