The documentation repo
The leafbuild.github.io
repo was created from the doc/book
directory.
The doc/book
directory is generated from doc/src
and doc/book.toml
by mdbook.
If you want to see the changes after you made them, make sure you have mdbook installed.
Running makers doc-build
from the root of the repo will automatically
generate doc/book
with all of its contents.
If you run makers doc-serve
from the root of the repo, you will have a
local instance of the doc site at http://localhost:3000.
After you are happy with the changes, submit a PR on
the master
branch,
and mention you changed the documentation, so the site can be rebuilt.
Please use reference-style links for all links to the main repo.
You can use rust
and leafbuild
for syntax highlighting.
Also the leafbuild
language declaration for highlight.js
can be found here.