Tildes Community Fork Docs

This page is about the docs site itself (the one you're looking at), how to build it locally and how to contribute to the documentation yourself.

As you may be able to tell it is built using mdBook, picked for its ease of use and because it brings a lot of functionality out of the box.

You can install mdBook by following one of the options from the official installation guide or if you have Nix installed, a flake is available that can be used together with Direnv to automatically load a development shell.

If none of that made any sense to you but you'd still like to offer notes or add documentation, feel free to reach out using any of the following ways with your contributions and we'll take care of adding them in for you!

Basic Usage

With mdBook installed and the repository cloned you can run the followings commands to open a live server or build the book:

# Start a live-reloading server and open your browser to the home page
mdbook serve --open

# Build the book, the output directory is "book/"
mdbook build