Docs

Make sure to read the environment setup guide before continuing.

The docs are built using docfx. To get started:

dotnet tool restore
cd docs
dotnet docfx .\docfx.json --serve

The docs will then be available at http://localhost:8080.

To build the docs while the server is already running, run in a new terminal:

dotnet docfx .\docfx.json

Linking

When linking to the docs for one of Whim's automatically generated docs, prefer using the xref Markdown autolinks or the xref Markdown links.

The IDs to use can be found in the uid field of the xrefmap.yml file. The xrefmap.yml will be generated at docs/_site/xrefmap.yml.

Before making a pull request, please run the markdownlint formatter, available as a Visual Studio Code extension and as command line tool.

# In the repo root, run the CLI formatter
markdownlint-cli2 --fix --config ".markdownlint-cli2.jsonc" "docs/**/*.md"

Use American English spelling for the docs.
The table of contents are not automatically built - to add a new page, you need to add it to the respective toc.yml.