SIBILS documentation

How to edit the documentation

Git clone

• Python must be installed
• git clone [email protected]:sibils/sibils-website
• cd sibils.github.io
• Start mkdocs:
  • Linux and Mac: ./serve
  • Windows: .\serve.bat
• Open http://127.0.0.1:8000/
• Change some files; the browser page is updated automatically.
• git add .; git commit; git push
• The website is going to update itself after a few minutes.

On GitHub

• On a web page, click on the pencil icon in the top right corner: the link goes to the GitHub page.
• Make the change on GitHub; check using the Preview tab.
• Confirm the change using the "Commit changes" at the bottom of the page (commit into the master branch).
• The website is going to update itself after a few minutes.

Change the website structure

• git clone the project.
• make the change into the nav section of mkdocs.yml.

Syntax

• markdown with Mkdocs
• markdown extensions provided by Material for Mkdocs:
  • Admonitions (Tips, Warning boxes)
  • Diagrams, see also mermaid documentation
  • Content tabs
  • Footnotes
  • Images with captions
  • Various list types
  • Abbreviations
  • Icons and emojis

Python Dependencies

• MkDocs for documentation generator
• Material for MkDocs for theme

Customizations used in this repository

• https://squidfunk.github.io/mkdocs-material/customization/
  • mkdocs.yml, section theme.custom_dir
  • overrides/partials/copyright.html: custom footer.
• https://squidfunk.github.io/mkdocs-material/setup/changing-the-colors/#custom-color-schemes
  • mkdocs.yml, section extra_css
  • mkdocs.yml, section theme.palette.scheme
  • docs/assets/extra.css
• https://squidfunk.github.io/mkdocs-material/setup/changing-the-fonts/#autoloading
  • disable Google Font to complying with the General Data Protection Regulation (GDPR)
  • mkdocs.yml, section theme.font
• https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#navigation-tabs
  • mkdocs.yml, theme.features.navigation.tabs
• https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#section-index-pages
  • mkdocs.yml, theme.features.navigation.indexes
• https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#hiding-the-sidebars
  • docs/index.md
  • docs/vocabularies.md

mkdocs.publish.yml

After each commit, the website is built and updated automaticaly using .github\workflows\publish.yml.

The mkdocs plugin social adds card when links from the website are shared (the preview link on Teams, Outlook, social media etc...).

This plugin requires dependencies that are complicated to install especially on Windows. An option ask to plugin not to build the cards, however the dependencies are still required.

The implemented solution uses two mkdocs configuration file:

• mkdocs.yml is the default configuration.
• mkdocs.publish.yml inherits from mkdocs.yml and adds the social plugin. The GitHub workflow uses this configuration file.

To sum up:

• don't care about mkdocs.publish.yml.
• make change in mkdocs.yml as expected.
• the scripts serve and serve.bat should work everything (Windows, Mac, Linux).