GiellaLT Documentation

GiellaLT provides rule-based language technology aimed at minority and indigenous languages

View GiellaLT on GitHub

Page Content

Debugging in-source documentation

When running 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?

Common errors

The most common errors in the generated documentation are the following:

  1. You have unbalanced marking, say you intend **word** but write **word*. The former is correct and gives boldface, the latter will make one * visible, and render the rest differently.

How to find and correct errors

How to write documentation

The Markdown syntax is described elsewhere.

In lang-XXX/docs/ do:


Then open in a Markdown editor, and start browsing, looking for errors.

Here some advices: