This repo contains the documentation for the Ontime project. It is build with Astro and starlight, please see the documentation
Ontime is a community project and any contribution is valuable. If you have have questions, call for clarifications or suggestions, please open an issue.
If you are comfortable with development, you are also welcome to create a Pull Request.
See below the main directories and files of the project. We omit the files inside the documentation as they would tend to get out of sync with implementation.
.
βββ public/
βββ src/
β βββ assets/
β βββ content/
β β βββ docs/
β β | βββ additional-notes <--- Implementation specific notes
β β | βββ api <--- API documentation
β β | βββ interface <--- Documentation of the views
β β | βββ ontime <--- Introduction documents
β β βββ config.ts
β βββ env.d.ts
βββ astro.config.mjs
βββ package.json
βββ tsconfig.json
Starlight looks for .md
or .mdx
files in the src/content/docs/
directory. Each file is exposed as a route based on its file name.
Images can be added to src/assets/
and embedded in Markdown with a relative link.
Static assets, like favicons, can be placed in the public/
directory.
All commands are run from the root of the project, from a terminal:
Command | Action |
---|---|
npm install |
Installs dependencies |
npm run dev |
Starts local dev server at localhost:4321 |
npm run build |
Build your production site to ./dist/ |
npm run preview |
Preview your build locally, before deploying |
npm run astro ... |
Run CLI commands like astro add , astro check |
npm run astro -- --help |
Get help using the Astro CLI |
Check out Starlightβs docs, read the Astro documentation, or jump into the Astro Discord server.