zhaofengli/colmena
1
1
Fork 0
mirror of https://github.com/zhaofengli/colmena.git synced 2024-10-03 20:57:33 +03:00
Code Issues Projects Releases Wiki Activity
main
colmena/manual/README.md
Zhaofeng Li ea4f2ba6dc Migrate other doc links to new domain
2022-05-13 19:14:58 -07:00

935 B
Raw Permalink Blame History

Manual

You can read the rendered version here.

Building the Manual

The manual is rendered using mdBook. To build the manual, do nix build .#manual. You can also do nix build .#manualFast for a version without the CLI usage reference.

Marking Text for Specific Versions

You can mark text to be only visible in the unstable version of the manual:

<!-- UNSTABLE_BEGIN -->
You are currently reading the unstable version of the Colmena Manual.
Features described here will eventually become a part of version @apiVersion@.
<!-- UNSTABLE_END -->

The opposite can be done with the STABLE_{BEGIN,END} markers:

<!-- STABLE_BEGIN -->
You are currently reading the version @apiVersion@ of the Colmena Manual.
<!-- STABLE_END -->

Substitutions

  • @version@ - Full version string
  • @apiVersion@ - Stable API version string (major.minor)