The documentation infrastructure is built on the following stones:
lang-xxx repositories (except private ones) have their
own online site as subsites of giellalt.github.io.
There are separate pages for keyboards and
language models with links directly to all subsite repos.
To update the online documentation, just save Markdown files in the
folder of the repository, commit (and if using
and the updated documentation will be online within a minute.
All source code in the
lang-XXX repositories containing
documentation markup will
be automatically parsed and the documentation extracted. The extracted
documentation will be automatically added to the site on the next
Source file types being scanned for documentation comments are:
The top directories
tools/, including all subdirs, are scanned.
Generated files of the above types are not scanned.
Mermaid support has recently been added to GtiHub, but the support does not include GtiHub Pages (not yet, at least). It does cover displaying Markdown source file views, README files, issues and discussion. By adding Mermaid support also to our GitHub Pages sites, there is parity between GH Pages and the rest of GitHub, and documents will render the same everywhere.
Based on counts of all files of the various types in all repositories in the GiellaLT infra.