Feature parity¶
The lists below detail our current feature parity with Material for MkDocs, including all features that were previously part of the Insiders Edition. For a look at what's next, see our roadmap to learn about what plans we have for Zensical that stretch far beyond Material for MkDocs.
This page is updated regularly as we make progress towards feature parity.
Core features¶
- Install with
pip install - Create new site
- Building from
mkdocs.yml - Built-in preview server
- Compatible with MkDocs file layout
- Python Markdown dialect
- Directory URLs
- Jinja templates
- YAML page metadata
- Extra CSS, JavaScript, templates
- Same browser support
- Link validation
Site and page structure¶
- 60+ language support
- Site language selector
- Header
- Automatically hiding header
- Announcement bar
- Git repository icon and link in header
- Code Actions
- Footer
- Footer navigation
- Social links
- Copyright notice
- Generator notice
- Comment system
- 404 pages
- Tags
- Revisioning1
Appearance¶
- Classic Material theme
- Assets and customization
- Template overrides
- Colors and palette toggle
- Automatic light and dark mode
- Custom colors and color schemes
- Fonts
- Icons, emojis, favicon
- Social cards
Markdown extensions¶
- Abbreviations
- Admonitions
- Annotations
- Attribute lists
- BetterEm
- Buttons
- Caption
- Caret, Mark & Tilde
- Code blocks, highlighting, copying
- Content tabs
- Critic
- Data tables
- Definition lists
- Details
- Diagrams (Mermaid)
- Footnotes
- Grids
- Highlight
- Icons and Emojis
- Images
- InlineHighlight
- Keys
- Markdown in HTML
- Math (MathJax, KaTeX)
- SmartSymbols
- Snippets
- Superfences
- Tabbed
- Table of contents
- Tables
- Tasklist
- Tooltips
Content¶
- Blog
- Comment system
- Versioning
- Repository
Navigation¶
- Explicit in
mkdocs.yml - Instant loading
- Instant prefetching
- Progress indicator
- Instant previews
- Anchor tracking
- Navigation tabs and sticky tabs
- Navigation sections
- Navigation expansion
- Navigation path (breadcrumbs
- Navigation pruning
- Section index pages
- Table of contents
- ToC anchor following
- ToC integration
- Back-to-top button
- Hiding navigation sidebar/ToC
- Keyboard shortcuts
- Content area width
- Automatic previews
- Automatic navigation
- Search
Optimization¶
- Site analytics and feedback widget
- Cookie consent
- Custom cookies
- Search engine optimization
- Data privacy
- Offline usage
Extensions¶
- Module system to replace hooks and plugins
-
This includes functionality that goes beyond the basic repository integration of Material for MkDocs, including document dates, authors, and contributors. ↩