Documenting your project
Begin by creating a
doc directory in the same directory
*.cabal) file is located.
Inside there should be at least two files:
- Another file
It is recommended that you name your files with a number at the beginning, e.g.:
The reason for this is that
tintin sorts the pages based
on their filename and then renders them in the navigation
All files must include a front matter with a title. Meaning that they all start with this header:
--- title: Title of the page ---
index.mdfile is generally "Home".
titleof the first file is generally "Getting started".
Generating the website
tintin run and you will have a website ready at