DocumenterLandingPage.jl
A VitePress-style landing page for Documenter.jl
Render a hero and feature tiles with emoji or image icons from YAML frontmatter, theme-adaptive across all of Documenter's shipped themes.
YAML frontmatter
The exact VitePress home layout — hero, actions, and feature tiles with emoji or image icons — all from one @raw html block. See the frontmatter reference.
Theme-adaptive
Mirrors Documenter's own theme palette, so the landing follows light, dark, and every catppuccin flavor, customizable through CSS variables.
Documenter plugin
Add plugins = [LandingPage()] to your makedocs call, and the stylesheet is injected automatically, no assets to configure.
CodeBlocks-ready
Pair it with DocumenterCodeBlocks, and both run in one build without conflicts.
Drop-in
Your frontmatter block stays byte-for-byte as written; only its rendering is replaced by the hero and tiles.
No toolchain
No VitePress, no Node, no custom theme — just base Documenter and a YAML block.
Markup in details
Tile copy renders inline Markdown — code spans, internal links, external links, and emphasis — with links resolving through the same rules as tile links.
What it is
This page is rendered by the plugin itself: the hero and the tiles above come from the YAML frontmatter in the @raw html block at the top of index.md, and the tiles' details show off the plugin's inline Markdown — code spans, links, and emphasis. See Markup in details for the full rules. Tiles with a link are clickable end to end — try the plugin, drop-in, and repository tiles — while the tiles that keep their links in the copy render as plain blocks.
Usage
Add the package and pass the plugin to makedocs:
using Documenter, DocumenterLandingPage, DocumenterCodeBlocksmakedocs( sitename = "MyPackage", format = Documenter.HTML(), plugins = [LandingPage(), CodeBlocks()],)See the API reference for the plugin's documentation.
See Styling: gradients and themes for how the landing's default gradients work with Documenter's themes and how to customize them.