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
- 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