mkdocs path

Migrating DevTools projects from Sphinx to MkDocs.


The good

  • Natively supported by RTD
  • Best theme for documentation material-docs
    • Very actively maintained
    • Also commercial plans and features
  • Python based
  • Popular, mkdocs itself 16k stars and materialk theme 13k

The bad

  • Main project lacks leadership
    • But it looks stable
  • Lots of plugins
    • Most under personal github accounts
  • Community health
    • mkdocstrings vs material-theme
    • some from original mkdocs team left
  • monorepo plugin by Spotify stuggle

Interactions so far

  • material theme - ๐ŸŸข very good
  • mkdocstring - ๐ŸŸข very good
  • mkdocs - ๐ŸŸก ok-ish
  • monorepo plugin - ๐ŸŸ  poor
    • zero feedback from Spotify folks
  • markdown-exec - ๐ŸŸข
  • other pluginsโ€ฆ (TBD)

Challanges

  • Monorepo plugin (single site conslidation)
    • Navigation with monorepo
    • File inclusion
    • Speed at scale (โ“)
    • Top right github links not pointing to project
  • Search scalability?

Ecosystem