https://peertube.watch/videos/watch/f5e1b02f-952b-41ea-ab69-80ac163ce2d4 I first used Material for MkDocs in April 2020, and it quickly became clear to me that this would become my tool of choice for all technical documentation I'm involved in. Since then, I have been involved in using Material for MkDocs for both creating new and revamping existing documentation sites, in collaboration with others: the EasyBuild documentation at docs.easybuild.io;, the EasyBuild tutorial at tutorial.easybuild.io;, the HPC-UGent documentation at docs.hpc.ugent.be;, the documentation of the EESSI project at eessi.io/docs;, an introductory tutorial to CernVM-FS at cvmfs-contrib.github.io/cvmfs-tutorial-2021;, In this talk I want to try and convince you that you should be using Material for MkDocs too. I will present a high-level overview of the project, highlight the features that got me hooked, and share my personal experience with using it to produce technical documentation. To demonstrate how easy it is to get started with Material for MkDocs from scratch, I will build a small documentation website step-by-step live during the talk to showcase some of its features. Material for MkDocs makes writing documentation easy and rewarding, and significantly lowers the bar to produce good looking yet practical technical documentation for free and open source software projects. It features a broad set of features, including (but not limited to): documentation written in MarkDown;, easy installation (via pip) and configuration (via mkdocs.yml);, code blocks with syntax highlighting;, support for dark/light mode;, fast and powerful search;, eye-popping customisable notes/warnings/tips via admonitions;, content tabs;, support for icons and emoji;, integration with GitHub Pages and GitLab Pages for easy publishing;, integration with Mermaid.js for creating diagrams;, integration with MathJax and KaTeX for displaying mathematical formulas;, built-in support for integrating a blog into your documentation;, Material for MkDocs is open source first (MIT-licensed), and follows the sponsorware release strategy (see Insiders). This means that new features are first exclusively released to sponsors and later become part of the free community edition when specific funding goals are met, which helps making the project sustainable. It is used by plethora of FOSS projects & beyond, like: arXiv, the open-access paper preprint repository: info.arxiv.org;, AutoGPT, a semi-autonomous agent powered by LLMs: docs.agpt.co;, CentOS, the Linux distribution: docs.infra.centos.org;, FastAPI, the Python web framework for building APIs: fastapi.tiangolo.com;, LUMI, Europe's fastest supercomputer: docs.lumi-supercomputer.eu;, Open Source at Siemens: opensource.siemens.com;, PyPI, the Python Package Index: docs.pypi.org;, Speakers: Kenneth Hoste, Martin Donath, Track: Tool the docs devroom, Room: K.4.601, When: Saturday 3 February 2024, 16:15–16:40 (Brussels time), Schedule: FOSDEM 2024 event page, Slides & links slides, Licence: Creative Commons Attribution 2.0 Belgium (CC BY 2.0 BE) (as stated in the FOSDEM video archive). Attribution: “Easily Going Beyond MarkDown with Material for MkDocs” by Kenneth Hoste, Martin Donath, FOSDEM 2024. Original recording: 2024/k4601/fosdem-2024-1815-easily-going-beyond-markdown-with-material-for-mkdocs.av1.webm from the FOSDEM video archive. This channel is an unofficial mirror; FOSDEM is a free and non-commercial event organised by the community for the community. Wed, 21 Oct 2026 23:04:00 GMT https://validator.w3.org/feed/docs/rss2.html PeerTube - https://peertube.watch https://peertube.watch/lazy-static/avatars/3b284627-b75f-409e-ac2e-10f4c2946f43.png https://peertube.watch/videos/watch/f5e1b02f-952b-41ea-ab69-80ac163ce2d4 All rights reserved, unless otherwise specified in the terms specified at https://peertube.watch/about and potential licenses granted by each content's rightholder.