Skip to content

Capability inventory

This inventory tracks the documentation families and plugin compatibility entries reviewed for this showcase. It does not claim exhaustive coverage of every option, combination, browser, or platform.

The local environment was checked with Zensical 0.1.0, UI 0.0.41, Python 3.13.15, and uv 0.12.19. These version checks do not verify the behavior of every example.

147 entries have example source; 6 are gaps; 2 are explicitly unsupported upstream. An example status means only that its source path exists. A gap can include a source illustration that is not a working demonstration. Per-feature behavior is unverified unless an entry explicitly records a verified version.

The official documentation changes over time. This snapshot was reviewed on 2026-11-08; compare its navigation and compatibility lists when updating it. A source path points to the repository, and may be a configuration file rather than a rendered page.

Authoring

Capability Status Example source Details
Markdown example Open example Representative example only; individual settings and behavior are not exhaustively verified.
Front matter example Open example Representative example only; individual settings and behavior are not exhaustively verified.
Admonitions example Open example Representative example only; individual settings and behavior are not exhaustively verified.
Buttons example Open example Representative example only; individual settings and behavior are not exhaustively verified.
Code blocks example Open example Representative example only; individual settings and behavior are not exhaustively verified.
Content tabs example Open example Representative example only; individual settings and behavior are not exhaustively verified.
Data tables example Open example Representative example only; individual settings and behavior are not exhaustively verified.
Diagrams example Open example Representative example only; individual settings and behavior are not exhaustively verified.
Footnotes example Open example Representative example only; individual settings and behavior are not exhaustively verified.
Formatting example Open example Representative example only; individual settings and behavior are not exhaustively verified.
Grids example Open example Representative example only; individual settings and behavior are not exhaustively verified.
Icons and emoji example Open example Representative example only; individual settings and behavior are not exhaustively verified.
Images example Open example Representative example only; individual settings and behavior are not exhaustively verified.
Lists example Open example Representative example only; individual settings and behavior are not exhaustively verified.
Math example Open example Representative example only; individual settings and behavior are not exhaustively verified.
Tooltips example Open example Representative example only; individual settings and behavior are not exhaustively verified.
Directives gap Open example Source illustration only; the separate Spark extension and catalog are not enabled.
## Setup
Capability Status Example source Details
Basics example Site behavior Configuration or demo source exists; this does not cover every setting or establish runtime behavior.
Colors example Open demo Configuration or demo source exists; this does not cover every setting or establish runtime behavior.
Fonts example Open demo Configuration or demo source exists; this does not cover every setting or establish runtime behavior.
Language and RTL example Open demo Configuration or demo source exists; this does not cover every setting or establish runtime behavior.
Logo and icons example Open demo Logo, favicon, and built-in theme icons are configured; behavior has not yet been verified.
Header example Open demo Configuration or demo source exists; this does not cover every setting or establish runtime behavior.
Footer example Open demo Copyright, social links and footer navigation are configured; behavior has not yet been verified.
Repository example Site behavior Configuration or demo source exists; this does not cover every setting or establish runtime behavior.
Data privacy example Open demo Configuration or demo source exists; this does not cover every setting or establish runtime behavior.
Navigation example Open demo Configuration or demo source exists; this does not cover every setting or establish runtime behavior.
Redirects example Open demo Configuration or demo source exists; this does not cover every setting or establish runtime behavior.
Validation example Build workflow A strict build of this intentionally broken link fails as expected; validation is boolean rather than severity configuration. Verified on Zensical 0.1.0.
Site search example Open demo Configuration or demo source exists; this does not cover every setting or establish runtime behavior.
Analytics gap Open example Explained in prose; no active behavior is demonstrated.
Blog example Open demo Configuration or demo source exists; this does not cover every setting or establish runtime behavior.
Tags example Open demo Configuration or demo source exists; this does not cover every setting or establish runtime behavior.
Comment system gap Open example Explained in prose; no active behavior is demonstrated.
Offline usage example Open demo Configuration or demo source exists; this does not cover every setting or establish runtime behavior.
## Plugin compatibility
Capability Status Example source Details
api-autonav example Open demo An isolated example is present; plugin settings and behavior require separate checks. Some integrations require extra dependencies.
audio example Open demo An isolated example is present; plugin settings and behavior require separate checks. Some integrations require extra dependencies.
autoapi example Open demo An isolated example is present; plugin settings and behavior require separate checks. Some integrations require extra dependencies.
autorefs example Open demo An isolated example is present; plugin settings and behavior require separate checks. Some integrations require extra dependencies.
awesome-nav example Open demo An isolated example is present; plugin settings and behavior require separate checks. Some integrations require extra dependencies.
blog example Open demo An isolated example is present; plugin settings and behavior require separate checks. Some integrations require extra dependencies.
callouts example Open demo An isolated example is present; plugin settings and behavior require separate checks. Some integrations require extra dependencies.
exclude example Open demo An isolated example is present; plugin settings and behavior require separate checks. Some integrations require extra dependencies.
gh-admonitions example Open demo An isolated example is present; plugin settings and behavior require separate checks. Some integrations require extra dependencies.
glightbox example Open demo An isolated example is present; plugin settings and behavior require separate checks. Some integrations require extra dependencies.
include-markdown example Open demo An isolated example is present; plugin settings and behavior require separate checks. Some integrations require extra dependencies.
literate-nav example Open demo An isolated example is present; plugin settings and behavior require separate checks. Some integrations require extra dependencies.
llmstxt example Open demo An isolated example is present; plugin settings and behavior require separate checks. Some integrations require extra dependencies.
macros example Open demo An isolated example is present; plugin settings and behavior require separate checks. Some integrations require extra dependencies.
markdown-exec example Open demo An isolated example is present; plugin settings and behavior require separate checks. Some integrations require extra dependencies.
markdownextradata example Open demo An isolated example is present; plugin settings and behavior require separate checks. Some integrations require extra dependencies.
meta example Open demo An isolated example is present; plugin settings and behavior require separate checks. Some integrations require extra dependencies.
mike example Open example The local build deploys two editions and a stable alias with mike; check the generated artifacts.
minify example Open demo An isolated example is present; plugin settings and behavior require separate checks. Some integrations require extra dependencies.
mkdocstrings example Open demo An isolated example is present; plugin settings and behavior require separate checks. Some integrations require extra dependencies.
nav-weight example Open demo An isolated example is present; plugin settings and behavior require separate checks. Some integrations require extra dependencies.
offline example Open demo An isolated example is present; plugin settings and behavior require separate checks. Some integrations require extra dependencies.
optimize example Open demo An isolated example is present; plugin settings and behavior require separate checks. Some integrations require extra dependencies.
privacy example Open demo An isolated example is present; plugin settings and behavior require separate checks. Some integrations require extra dependencies.
redirects example Open demo An isolated example is present; plugin settings and behavior require separate checks. Some integrations require extra dependencies.
rss example Open demo An isolated example is present; plugin settings and behavior require separate checks. Some integrations require extra dependencies.
search example Open demo An isolated example is present; plugin settings and behavior require separate checks. Some integrations require extra dependencies.
section-index example Open demo An isolated example is present; plugin settings and behavior require separate checks. Some integrations require extra dependencies.
social example Open demo An isolated example is present; plugin settings and behavior require separate checks. Some integrations require extra dependencies.
table-reader example Open demo An isolated example is present; plugin settings and behavior require separate checks. Some integrations require extra dependencies.
tags example Open demo An isolated example is present; plugin settings and behavior require separate checks. Some integrations require extra dependencies.
video example Open demo An isolated example is present; plugin settings and behavior require separate checks. Some integrations require extra dependencies.
gen-files unsupported — Upstream lists this plugin as unsupported; there is no active demo.
open-in-new-tab unsupported — Upstream lists this plugin as unsupported; there is no active demo.
## Markdown compatibility
Capability Status Example source Details
Abbreviations example Open example Representative example only; individual settings and behavior are not exhaustively verified.
Admonition example Open example Representative example only; individual settings and behavior are not exhaustively verified.
Attribute Lists example Open example Representative example only; individual settings and behavior are not exhaustively verified.
Definition Lists example Open example Representative example only; individual settings and behavior are not exhaustively verified.
Footnotes example Open example Representative example only; individual settings and behavior are not exhaustively verified.
Markdown in HTML example Open example Representative example only; individual settings and behavior are not exhaustively verified.
Table of Contents example Open example Representative example only; individual settings and behavior are not exhaustively verified.
Tables example Open example Representative example only; individual settings and behavior are not exhaustively verified.
Arithmatex example Open example Representative example only; individual settings and behavior are not exhaustively verified.
Caption example Open example Rendered image and table captions were inspected in the built output; see also the table example. Verified on Zensical 0.1.0.
Caret, Mark and Tilde example Open example Representative example only; individual settings and behavior are not exhaustively verified.
Details example Open example Representative example only; individual settings and behavior are not exhaustively verified.
Emoji example Open example Representative example only; individual settings and behavior are not exhaustively verified.
Highlight example Open example Representative example only; individual settings and behavior are not exhaustively verified.
InlineHilite example Open example Representative example only; individual settings and behavior are not exhaustively verified.
Keys example Open example Representative example only; individual settings and behavior are not exhaustively verified.
SmartSymbols example Open example Built output contains the copyright, trademark, and fraction substitutions. Verified on Zensical 0.1.0.
Snippets example Open example Representative example only; individual settings and behavior are not exhaustively verified.
SuperFences example Open example Representative example only; individual settings and behavior are not exhaustively verified.
Tabbed example Open example Representative example only; individual settings and behavior are not exhaustively verified.
Tasklist example Open example Representative example only; individual settings and behavior are not exhaustively verified.
## Other compatibility
Capability Status Example source Details
MkDocs migration example Build workflow A limited TOML/YAML comparison builds the same fixture; it does not cover all migration settings. Verified on Zensical 0.1.0.
MkDocs versioning example Open example Two editions and a stable alias are produced by the local mike deployment workflow; verify its generated artifacts with the project checks.
CLI create, preview, and build example Open example Build workflow and reproducible checks are documented; new-project and preview flows are not demonstrated end to end.
## Theme feature options
Capability Status Example source Details
navigation.tabs example Open demo Source example exists; runtime behavior and every option are not yet verified.
navigation.tabs.sticky example Open demo Source example exists; runtime behavior and every option are not yet verified.
navigation.sections example Open demo Source example exists; runtime behavior and every option are not yet verified.
navigation.expand example Open demo Source example exists; runtime behavior and every option are not yet verified.
navigation.prune example Open demo Source example exists; runtime behavior and every option are not yet verified.
navigation.indexes example Open demo Source example exists; runtime behavior and every option are not yet verified.
navigation.path example Open demo Source example exists; runtime behavior and every option are not yet verified.
navigation.footer example Open demo Source example exists; runtime behavior and every option are not yet verified.
toc.integrate example Open demo Source example exists; runtime behavior and every option are not yet verified.
toc.follow example Open demo Source example exists; runtime behavior and every option are not yet verified.
navigation.instant example Open demo Source example exists; runtime behavior and every option are not yet verified.
navigation.instant.prefetch example Open demo Source example exists; runtime behavior and every option are not yet verified.
navigation.instant.progress example Open demo Source example exists; runtime behavior and every option are not yet verified.
navigation.instant.preview example Open demo Source example exists; runtime behavior and every option are not yet verified.
navigation.tracking example Open demo Source example exists; runtime behavior and every option are not yet verified.
navigation.top example Open demo Source example exists; runtime behavior and every option are not yet verified.
header.autohide example Open demo Source example exists; runtime behavior and every option are not yet verified.
content.action.edit example Open demo Source example exists; runtime behavior and every option are not yet verified.
content.action.view example Open demo Source example exists; runtime behavior and every option are not yet verified.
content.code.copy example Open demo Source example exists; runtime behavior and every option are not yet verified.
content.code.select example Open demo Source example exists; runtime behavior and every option are not yet verified.
content.code.annotate example Open demo Source example exists; runtime behavior and every option are not yet verified.
search.suggest example Open demo Source example exists; runtime behavior and every option are not yet verified.
search.highlight example Open demo Source example exists; runtime behavior and every option are not yet verified.
search.share example Open demo Source example exists; runtime behavior and every option are not yet verified.
## Setup options
Capability Status Example source Details
Modern theme example Open demo Source example exists; runtime behavior and every option are not yet verified.
Classic theme example Open demo Source example exists; runtime behavior and every option are not yet verified.
Light and dark system palette example Site behavior Source example exists; runtime behavior and every option are not yet verified.
Fixed dark palette example Open demo Source example exists; runtime behavior and every option are not yet verified.
Primary and accent colors example Open demo Source example exists; runtime behavior and every option are not yet verified.
Custom text and code fonts example Open demo Source example exists; runtime behavior and every option are not yet verified.
System fonts without remote fonts example Open demo Source example exists; runtime behavior and every option are not yet verified.
Right-to-left language example Open demo Source example exists; runtime behavior and every option are not yet verified.
Page title, icon and status example Open example Source example exists; runtime behavior and every option are not yet verified.
Per-page navigation and table of contents visibility example Open example Source example exists; runtime behavior and every option are not yet verified.
Per-page path and footer visibility example Open example Source example exists; runtime behavior and every option are not yet verified.
Navigation pruning and index pages example Open demo Source example exists; runtime behavior and every option are not yet verified.
Redirect mappings example Open demo Source example exists; runtime behavior and every option are not yet verified.
Search suggestions and highlighting example Open demo Source example exists; runtime behavior and every option are not yet verified.
Offline site generation example Open demo Source example exists; runtime behavior and every option are not yet verified.
Analytics provider and event collection gap Open example Explained but no analytics service is connected.
Comment service integration gap Open example Explained but no comment service is connected.
Link and anchor validation example Build workflow An intentionally broken link fails a strict build; the fixture enables link and anchor checks. Verified on Zensical 0.1.0.
Page feedback control gap Open example Explained but no feedback service is connected.
Logo, favicon and custom icons example Open demo Logo, favicon, and built-in theme icons are configured; behavior has not yet been verified.
Custom CSS and template overrides example Open demo CSS and an override directory are configured; output has not yet been verified.
## Authoring options
Capability Status Example source Details
Admonition types and custom titles example Open example Source example exists; runtime behavior and every option are not yet verified.
Code highlighting and annotations example Open example Source example exists; runtime behavior and every option are not yet verified.
Nested content tabs example Open example Source example exists; runtime behavior and every option are not yet verified.
Table alignment example Open example Source example exists; runtime behavior and every option are not yet verified.
Image lazy loading and palette variants example Open example Source example exists; runtime behavior and every option are not yet verified.
Image alignment example Open example Source example exists; runtime behavior and every option are not yet verified.
Nested lists example Open example Source example exists; runtime behavior and every option are not yet verified.
Inline formatting example Open example Source example exists; runtime behavior and every option are not yet verified.
Reference and glossary tooltips example Open example Source example exists; runtime behavior and every option are not yet verified.
Block grid example Open example Source example exists; runtime behavior and every option are not yet verified.
Page metadata example Open example Source example exists; runtime behavior and every option are not yet verified.
## Build workflow
Capability Status Example source Details
exclude_docs example Open demo Production output and navigation were inspected locally. Preview behavior was not tested. Verified on Zensical 0.1.0.
draft_docs example Open demo Production output and navigation were inspected locally. Preview behavior was not tested. Verified on Zensical 0.1.0.
not_in_nav example Open demo Production output and navigation were inspected locally. Preview behavior was not tested. Verified on Zensical 0.1.0.
use_directory_urls example Open demo Production output and navigation were inspected locally. Preview behavior was not tested. Verified on Zensical 0.1.0.
Explicit navigation example Open demo Production output and navigation were inspected locally. Preview behavior was not tested. Verified on Zensical 0.1.0.