logoalt Hacker News

Show HN: MkSlides – Markdown to slides with a similar workflow to MkDocs

56 pointsby MartenBEtoday at 1:00 PM7 commentsview on HN

As a teacher, we keep our slides as markdown files in git repos and want to build these automatically so they can be viewed online (or offline if needed). To achieve this, I have created MkSlides. This tool converts all markdown in a folder to slides generated with Reveal.js. The workflow is very similar to MkDocs.

Install: `pip install mkslides`

Building slides: `mkslides build`

Live preview during editing: `mkslides serve`

Comparison with other tools like marp, slidev, ...:

- This tool is a single command and easy to integrate in CI/CD pipelines.

- It only needs Python.

- The workflow is also very similar to MkDocs, which makes it easy to combine the two in a single GitHub/GitLab repo.

- Generates an index landing page for multiple slideshows in a folder which is really convenient if you have e.g. a slideshow per chapter.

- It is lightweight.

- Everything is IaC.


Comments

abdullahkhalidstoday at 4:18 PM

Don't you find the linear format of slides built in this fashion very constraining?

Many excellent presenters use a slide as a 2D canvas on which text and images can be placed in arbitrary locations - whatever best helps get the ideas across to the audience. Is losing this feature worth the advantages of this tool?

show 2 replies
dkdciotoday at 3:31 PM

Quarto also supports this: https://quarto.org/docs/presentations/

not sure if Quarto-specific but it lets you have Python code is slides too which is nice, i.e. can directly use visualization libraries

jimmySixDOFtoday at 3:57 PM

Reveal.js vs Sli.dev seems like a toss up I am sure there are nuanced differences or maybe I am missing something obvious ?

jsilencetoday at 7:03 PM

Why not Quarto? Genuinely curious.

lowbloodsugartoday at 3:33 PM

I’ve used presenterm. Like it a lot.

https://mfontanini.github.io/presenterm/