Top all-time · #1128
Martin Donath
Personal blog · squidfunk.github.ioprogrammingwriting
Martin Donath's personal blog at squidfunk.github.io covers programming and writing. Since 2016, 64 different Hacker News readers have linked it 96 times, most often “Technical documentation that just works”. No feed was found, so read it on the site itself.
Most-linked posts?
- Technical documentation that just works39 people · 44 mentions · first linked 2017-11-06
- Mkdocs Material: Insiders10 people · 12 mentions · first linked 2021-01-23
- /mkdocs-material/getting-started/5 people · 5 mentions · first linked 2020-05-16
- Zensical – A modern static site generator built by the Material for MkDocs team3 people · 4 mentions · first linked 2025-11-05
- Show HN: A material design theme for MkDocs2 people · 2 mentions · first linked 2016-02-09
- What MkDocs 2.0 means for your documentation projects2 people · 2 mentions · first linked 2026-07-01
- Blog support just landed – Material for MkDocs2 people · 2 mentions · first linked 2022-09-12
- Show HN: Material for MkDocs 62 people · 2 mentions · first linked 2020-09-27
What Hacker News says?
This certainly does look like an interesting solution, I'd be keen to try it myself. However, just in case you didn't already know about Lunr ( https://lunrjs.com/ ), it is fairly commonly used to implement search on static websites. e.g. https://squidfunk.github.io/mkdocs-material/ There are of course other similar libraries too. EDIT: Whoops, just saw a few comments below Lunr is already mentioned.
Comment linking /mkdocs-material/
on “Hosting SQLite databases on GitHub Pages or any static file hoster”Submitted Technical documentation that just works as a story · 208 points
HN discussionActually, we use mkdocs and the excellent material for mkdocs theme: https://squidfunk.github.io/mkdocs-material/
Comment linking /mkdocs-material/
on “Run CUDA, unmodified, on AMD GPUs”Submitted Zensical – A modern static site generator built by the Material for MkDocs team as a story · 168 points
HN discussionOn the topic of showing page progress with table of contents, author's description matches exactly how it is implemented in Material for MkDocs [1]. I moved my blog from WordPress to it (for unrelated reasons) and I immediately liked how going through longer blog posts felt with highlighted entry in the table of contents moving together with the page. [1] https://squidfunk.github.io/mkdocs-material/setup/setting-up.…
Comment linking /mkdocs-material/setup/setting-up-navigation/
on “Microfeatures I love in blogs and personal websites”Submitted Zensical – A modern static site generator built by the Material for MkDocs team as a story · 7 points
HN discussionhttps://squidfunk.github.io/mkdocs-material/getting-started/ = this is what I meant.
Comment linking /mkdocs-material/getting-started/
on “Show HN: I wrote a book about Go”Submitted What MkDocs 2.0 means for your documentation projects as a story · 3 points
HN discussionWould be good to copy from MkDocs Material https://squidfunk.github.io/mkdocs-material/reference/code-b... ``` py hl_lines="2 3" def bubble_sort(items): for i in range(len(items)): for j in range(len(items) - 1 - i): if items[j] > items[j + 1]: items[j], items[j + 1] = items[j + 1], items[j] ```
Comment linking /mkdocs-material/reference/code-blocks/
on “Include diagrams in your Markdown files with Mermaid”Submitted Transforming Material for MkDocs as a story · 3 points
HN discussionJup, MathJax is supported with minimal setup: https://squidfunk.github.io/mkdocs-material/reference/mathja...
Comment linking /mkdocs-material/reference/mathjax/
on “Markdoc: Stripe's Markdown-based authoring framework”Submitted Mkdocs Material: Insiders as a story · 3 points
HN discussionAnother important requirement for me is support for Math notation in docstrings and elsewhere. Looks like MkDocs supports mathjax? https://squidfunk.github.io/mkdocs-material/reference/mathja...
Comment linking /mkdocs-material/reference/mathjax/
on “Markdoc: Stripe's Markdown-based authoring framework”Submitted Blog support just landed – Material for MkDocs as a story · 3 points
HN discussionFor anyone looking for a doc generation tool: I was lately evaluating several tools like VuePress, Docusaurus and AsciiDoc. I ended up using Mkdocs Material ( https://squidfunk.github.io/mkdocs-material/ ). If you haven't already, have a look. I think it is pretty impressive. From tags, tabs to the fantastic built-in search ...
Comment linking /mkdocs-material/
on “Markdoc: Stripe's Markdown-based authoring framework”Submitted Show HN: A material design theme for MkDocs as a story · 3 points
HN discussionhttps://0xfab1.net/ HN has motivated me to start writing stuff down and publish it. (thx ^^) I started about 16 months ago and it has been a great experience. The site is based on MkDocs [1] with Material [2] theme built using GitHub actions (and various other services; see GitHub readme [3]) [1] https://www.mkdocs.org [2] https://squidfunk.github.io/mkdocs-material [3] https://github.com/FullByte/FullByte.github.io
Comment linking /mkdocs-material
on “Ask HN: Share your personal site”Submitted Material for MkDocs Insiders – Now free for everyone as a story · 2 points
HN discussion> I just want CD to send my docs from git to a system that can properly host / give me the Doc-related features I need. Material for Mkdocs does exactly this. https://squidfunk.github.io/mkdocs-material/
Comment linking /mkdocs-material/
on “Show HN: I am building an open-source Confluence and Notion alternative”Submitted Material for MkDocs is now in maintenance mode, Squidfunk announces Zensical as a story · 2 points
HN discussionYou mean https://squidfunk.github.io/mkdocs-material/ ? Try opening that site, and press the Down or PgDown keys on your keyboard.
Comment linking /mkdocs-material/
on “I paid people to try and follow my README”Submitted Material for MkDocs Insiders: Sponsorware as a story · 2 points
HN discussionMine is just a default setup of this: https://squidfunk.github.io/mkdocs-material/ Document folder structure similar to yours. I'm going to look through your collection, looks interesting :-)
Comment linking /mkdocs-material/
on “Show HN: CookLang – Recipe Markup Language”Submitted Material for MkDocs: guide to using built-in plugins as a story · 2 points
HN discussionDo you have an example link of a site running mkdocs with material theme? Edit: I'm guessing it's this? https://squidfunk.github.io/mkdocs-material/getting-started/
Comment linking /mkdocs-material/getting-started/
on “Blog with Markdown and Git, and degrade gracefully through time”Submitted Material for MkDocs 1.0.0 released – a complete overhaul as a story · 2 points
HN discussionThe real gem highlighted by backstage is the MkDocs Material theme: https://squidfunk.github.io/mkdocs-material/ It's seriously awesome and has a lot of nice customization options. Out of the box it makes very clean and professional technical docs from a pile of markdown files. Even if you don't need to go the whole backstage route, seriously consider using mkdocs and the material theme.
Comment linking /mkdocs-material/
on “I spent two years trying to do what Backstage does for free”Submitted What MkDocs 2.0 means for your documentation projects as a story · 1 points
HN discussionThis is indeed a problem. However, given that you need to pay for a subscription to get access, I consider the risk rather low. The Insiders code is released under the same license (MIT), as I didn't want to make things complicated, so I couldn't even enforce someone publishing it. I have a fair-use policy [1] that (up to now) all users respect. Yes, the model is far from being perfect, but it allows me to pay at le…
Comment linking /mkdocs-material/insiders/
on “Build a salary with GitHub Sponsors”Submitted Zensical – A modern static site generator built by the Material for MkDocs team as a story · 1 points
HN discussion
