DocumenterLandingPage.jl

A VitePress-style landing page for Documenter.jl

Render a hero and emoji feature tiles from YAML frontmatter, theme-adaptive across all of Documenter's shipped themes.

DocumenterLandingPage.jl DocumenterLandingPage.jl
📄

YAML frontmatter

The exact VitePress home layout, with hero, actions, and emoji feature tiles, all from one YAML frontmatter block.

🎨

Theme-adaptive

Mirrors Documenter's own theme palette, so the landing follows light, dark, and every catppuccin flavor.

🧩

Documenter plugin

Add it to your plugins list, 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.

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.

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.