shouldiuse.io

Categories

VERDICT

Squidfunk (Material for MkDocs) Review

Depends

Should I use Squidfunk (Material for MkDocs)?

Documentation that simply works - squidfunk.github.io

· 2 weeks ago

A strong fit for developer teams publishing markdown docs on a budget — the core is free and battle-tested by 85K repos. Skip it if you want hosted, click-and-edit docs or a vendor with support SLAs, and note it's drifting toward maintenance mode as its author builds Zensical.

Confidence

Medium. Based on ~20 public sources; many snippets truncated, so depth is limited.

Ratings

  • Value for money
  • Ease of use
  • Feature depth
  • Support quality
  • Security posture

Pricing

Free

Open source

ModelNot disclosed
Monthly feesNot disclosed
HardwareNot disclosed
Free tierYes
InsidersFrom $15/mo

Best for

  • Developer teams with markdown docs
  • Open-source projects needing polish
  • Docs hosted on GitHub Pages
  • API and engineering documentation

Not for

  • Non-technical teams wanting hosted, click-and-edit docs
  • Anyone needing vendor SLAs or paid support contracts
  • Teams wary of tools sliding into maintenance mode
  • Buyers who treat this page as a standalone product to purchase

Gotchas - check before you buy

medium

Maintenance mode means mostly critical fixes; plan a possible migration to Zensical

medium

Search XSS CVE-2026-73295 (CVSS 5.4) — keep versions updated

low

Insiders pricing changed in 2022 — verify current tiers before sponsoring

low

No security page found on the site itself

Pros and cons

Pros

  • Free open-source core used by 85K GitHub repos
  • Feature-rich: search, tooltips, blog, social plugins
  • Insiders sponsor tier starts at just $15/month
  • Long-tracked community favorite since 2016

Cons

  • 2026 reviews flag it heading into maintenance mode
  • Author building successor 'Zensical' static site generator
  • DOM XSS disclosed in search suggestions (CVE-2026-73295)
  • Community-only support; Gitter channel sunset in 2023

Sources & method

- 10 sources - One medium-severity DOM XSS (CVE-2026-73295, CVSS 5.4) disclosed via GitHub advisory; otherwise clean in reviewed sources.

official x6review x2security x2
  • CVE-2026-73295 — DOM XSS in search suggestions, Medium-severity (CVSS 5.4) DOM XSS via query parameter in search suggestions.

Key stats

  • Value for money: 5/5

    Rating

  • Free

    Starting price

  • 10

    Sources

  • Analyzed

  • Value for money: 5/5. Free core; sponsor tier from $15/mo
  • Ease of use: 4/5. Markdown-based, 'simply works' positioning
  • Feature depth: 5/5. Search, tooltips, blog, social plugins built in
  • Support quality: 3/5. Community-only; Gitter sunset in 2023
  • Security posture: 3/5. One medium XSS CVE; no security page
  • 85K repos GitHub adoption per GitHub/ecosyste.ms
  • $15/mo Starting price Insiders sponsor tier
  • Yes Free tier core theme is open source
  • CVSS 5.4 Top CVE severity medium, DOM XSS (2026)

Pricing

Open source

Free

  • Full core theme
  • Community support via GitHub

Insiders

From $15/mo

  • Sponsor-only extras
  • Early access features

Security

One medium-severity DOM XSS (CVE-2026-73295, CVSS 5.4) disclosed via GitHub advisory; otherwise clean in reviewed sources.

  • CVE-2026-73295 — DOM XSS in search suggestionsMedium-severity (CVSS 5.4) DOM XSS via query parameter in search suggestions.⁷

What users say

Developers have long recommended Material for MkDocs as their go-to docs theme, though 2026 commentary focuses on its maintenance-mode status.

“My favorite for now stays mkdocs”
Hacker News

Companies that use it

  • AWS (Powertools for AWS Lambda Python docs)
Full analysis

Based on ~20 public sources; many snippets truncated, so depth is limited.

Free, polished docs theme for dev teams — but entering maintenance mode as its author builds successor Zensical.

Methodology

Based on ~20 public sources; many snippets truncated, so depth is limited.

Read how a report is made.

Sources

  1. Material for MkDocs — GitHub repositorygithub.com
    official
  2. Why does Insiders start at $15/month?github.com
    official
  3. Upcoming price change for Insidersgithub.com
    official
  4. Zensical — a modern static site generatorsquidfunk.github.io
    official
  5. Sunsetting Gittersquidfunk.github.io
    official
  6. Material for MkDocs: Honest 2026 Review (Maintenance Mode)docsio.co
    review
  7. CVE-2026-73295 — NVDnvd.nist.gov
    security
  8. DOM XSS advisory GHSA-xvg9-69gf-fjrfgithub.com
    security
  9. Hacker News thread on docs toolsnews.ycombinator.com
    review
  10. squidfunk (Martin Donath) on GitHubgithub.com
    official

Add this review to your site

This check for Squidfunk (Material for MkDocs) says Depends.

Put the badge on your site.

Visitors see the independent review.

The link points here, and search engines follow it.

This is the badge visitors see on your site.

Depends Squidfunk (Material for MkDocs) Independent review on Should I Use It

Paste one snippet. Keep the link as it is. A nofollow tag stops search engines from following it.

Rate this review

Anonymous. You can change your vote.

Loading votes…

Comments

One queue. No nested comments. Give a display name first. Limit: 200 words per comment and 7 comments per day. You can edit or delete yours.

Save a name to write a comment.

0 / 200 words

No comments yet.