Slides¶

After seeing Nicola's and Henk's presentation I wanted to recreate it for my own use in my FabLab. Nicola told me to use remark.js. I did a lot of research and testing and I figured out that I was trying to use the wrong remark.js.

So now I am trying to install MKSlides

Install¶

Requirements¶

Python¶

Check your python version.

Mine is in .gitlab-ci.yml

I needed to update it as mkslides did not work with my originally installed version. I was on python:3.11-slim and now I am on python:3.14-slim

Source for latest python version.

MkSlides¶

PyPI Repo

Add

mkslides ~= 2.0.15

to requirements.txt to install the plugin

Build & Script¶

Back in gitlab-ci.yml

You will want to add the following code in the script parts where you deploy your website:

  # Build slides with MkSlides
  - time mkslides build --site-dir public/slides

mkslides.yml¶

So I just created a new file in an already existing documentation (this one). So now I have mkdocs and mkslides yml

I just copy pasted the full code example given in the github repo. My first objective is to make it work than to customize it.

Path¶

You want to have the slides folder at the same level as docs and the yml files. Otherwise you will need to change the path in the yml code.

Slide Test¶

I copy pasted the following slide for testing.

Customization¶

Themes