Skip to content

OpenOlat documentation

The OpenOlat documentation is based on MkDocs using the material theme and some plugins. The manual is written using the markdown syntax.

Resources:

File structure

  • Landing page:
    • The page structure is defined in the mkdocs.yml file within the space
    • Page files are located in /docs/
  • Sites
    • Contains all the manual sections (release notes, user manual, admin manual tech doc etc)
    • Each site
    • The page structure is defined in the mkdocs.ymlfile within the space
    • Page files are located in /docs/ folder within the site
    • For more info see the monorepo plugin docu
  • i18n
    • Normal xyz.md files are in EN (default) since not all spaces are available in all languages
    • The corresponding DE version have the xyz.de.md file ending
    • The same file pattern applies to images as well.
    • For more info see the static i18n plugin docu

Referencing from OpenOlat

OpenOlat uses the page URL including anchors to link to specific areas of the documentation. Thus, changing page names and anchors must be modified in sync with the corresponding references within the OpenOlat code. The URL is derived from the page file name: about.md will lead to the URL ..../about/.

Normally markdown generates HTML anchors for each title element automatically. This is unhandy when writing a multi-language documentation where not only the link to pages but also the link to the dedicated chapter in the page must be linkable from OpenOlat. Thus, the anchors must be set explicitly using the attr-listattr-list markdown extension:

# This is a title {: #this-is-the-anchor-to-this-title }

The hierarchical structure of URL's is defined in the mkdocs.yml file.

Manual versions

The manual is published from the GIT master version on the server in the /current/ directory. Whenever a new main OpenOlat version is published, the documentation is tagged with the same tag and a branch is created. This docu branch is then published in a version directory like 16.1.

Working on the documentation

Install docu development environment

MkDocs uses the Python programming language. You first need to install python3 and pip3 to use MkDocs.

MacOS: there are several ways to to install MkDocs on MacOS, one simple ways is to use the brew package manager. To continue you must first install brew. 

# Basic Python 3 installation
brew install python

# Install MkDocs
pip3 install mkdocs

#Install MkDocs theme and plugins
pip3 install mkdocs-material
pip3 install mkdocs-monorepo-plugin   
pip3 install mkdocs-static-i18n

Markdown editor and Git client

Any Markdown editor and any Git client can be used. To make things simple we recommend to download Visual Code Studio that combines a Git client, a decent Markdown editor and a Markdown preview in one single tool. It is available for free for Mac, Windows and Linux.

On the Mac the installation is very simple:

brew install --cask visual-studio-code

Git project URL

The public repository is available at the following Git URL: 

https://github.com/OpenOLAT/OpenOLAT-docs.git

Note that this is a read-only repository. If you are frentix staff and want to modify the repo, please ask for our interal Git Repo.

Local preview

When editing the files it is recommended to start a local server to preview the changes. The server reloads the pages on every change. Since the manual is large, reloading of changes can take quite some time. 

cd OpenOLAT-docs  
python3 -m mkdocs serve

Now open http://127.0.0.1:8000/ in your browser to navigate and preview.

Export site as static HTML files

For publishing the documentation, compile it and publish it on your server. 

cd OpenOLAT-docs
python3 -m mkdocs build
cd site
scp -r ??* oodocs@docs.openolat.org:/home/oodocs/html/.
Back to top