We're sorry but this page doesn't work properly without JavaScript enabled. Please enable it to continue.
Feedback

Easily Going Beyond MarkDown with Material for MkDocs

Formal Metadata

Title
Easily Going Beyond MarkDown with Material for MkDocs
Title of Series
Number of Parts
798
Author
License
CC Attribution 2.0 Belgium:
You are free to use, adapt and copy, distribute and transmit the work or content in adapted or unchanged form for any legal purpose as long as the work is attributed to the author in the manner specified by the author or licensor.
Identifiers
Publisher
Release Date
Language

Content Metadata

Subject Area
Genre
Abstract
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.