• Rust
• Node.js
• pnpm

The documentation site is built with Astro Starlight and reuses it's project structure.

docs/
├── public/
├── src/
│   ├── assets/
│   ├── content/
│   │   ├── docs/
│   │   └── config.ts
│   └── env.d.ts
├── tests/
├── 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. They will be optimized for download size and also their width and height will be extracted so the framework can render them without ugly content shifts.

Static assets, like favicons, can be placed in the public/ directory. Note that images in this folder will not be processed and optimized by Starlight.

The docs use a lot of autogenerated content. First create all the screenshots which will be placed at src/assets/generated/.

cargo run -p slint-docsnapper -- docs/src/content --overwrite

Then generate the slint auto generated content.

cargo xtask slintdocs

This xtask also installs the npm dependencies and builds the docs. The equivalent of:

pnpm i --ignore-scripts
pnpm run build

--ignore-scripts is needed because this is a monorepo and pnpm i will install the dependencies of all the projects as well as run any install scripts. Currently the api/node project will attemtpt to compile

This will build the site and place it in dist/.

To run the live hot reloading dev server run:

pnpm start

This will start the dev server at localhost:4321.

All commands are run from the root of the project, from a terminal:

Check out Starlight’s docs, read the Astro documentation, or jump into the Astro Discord server.