make, the in-source documentation will be extracted and stored in Markdown documents in the
docs/ directory. After you commit your changes (and push them, if using git), you can view the documentation on GitHub Pages.
But what if the result does not look like you expected?
The most common errors in the generated documentation are the following:
**word*. The former is correct and gives boldface, the latter will make one * visible, and render the rest differently.
The Markdown syntax is described elsewhere.
index.md in a Markdown editor, and start browsing, looking for errors.
Here some advices:
!!does not mean “very important”, it means “will be included in a document”