Documentation overview
How this documentation is written
- try to use the tool, figure out how things work, ask questions to the developers
- write it down as clearly as possible to pave the path for other users
- with input from users and developers, make it better over time
How this documentation is structured
- content is written and structured around the matrix proposed by the Documentation System
- TL;DR: there are four types of documentation: tutorials, how-tos, reference, explanations
- this system makes it easier for users to find what they are looking for, and for authors to expand and maintain the docs
How this documentation is built
- documentation source is available as a separate repository (public & open-source)
- documentation website is built with Jekyll and served with GitHub Pages
- content is written in kramdown (markdown) with bits in html (mostly tables)
- templates are written in Liquid
- responsive layout is implemented with Bootstrap
- additional styles are written in Sass (for example custom font, custom classes, icon, etc.)
- the website is updated automatically at every commit to the
mainbranch of the repository
How the repository is structured
fontra-docs
├── _includes/
├── _layouts/
├── _py/
├── css/
├── images/
├── videos/
├── _introduction/
├── _reference/
├── _explanations/
├── _tutorials/
├── _how-tos/
├── index.md
└── 404.html
System (developers, designers)
-
_includes
-
modular template parts such as header and footer
-
_layouts
-
just a single
default.htmltemplate for now -
_py
-
Python scripts used to create images, etc.
-
css
-
contains
style.sasswith custom styles only -
404.html
-
page for Page not found errors
-
_config.yml
-
Jekyll configuration file with project metadata
Content (documentation authors)
-
tutorials
-
sources for pages in the Tutorials section
-
how-tos
-
sources for pages in the How-Tos section
-
reference
-
sources for pages in the Reference section
-
explanations
-
sources for pages in the Explanations section
-
index.md
-
home page of the documentation
-
images
-
all images (screenshots, icons, etc.)
-
videos
-
all videos
See also
Improve this page on GitHub
· This documentation is licensed under CC BY 4.0
· Built 2026-10-27