Vitepress Theme Akari Docsv1.0.0GitHubSettingsMore

Overview ​

Vitepress Theme Akari Docs is a documentation theme built with VitePress and @m3e/web.

Installation guide Theme ready Web Components v1.0.0

Features ​

Material 3 Expressive
Color, shape, motion and typography all come from the m3e design tokens and match the official Material 3.
Organized by folders
In a language folder, folders are categories and the folders in them are articles. The navigation and the language list come from the folders and the frontmatter.
Parallel pages and hero
An article can be split into several pages, switched with a tab bar. A page with a hero takes its colors from the image.
Settings and appearance
Four light and dark modes. Color, variant, contrast, motion, text direction and text size apply instantly and are saved in the current browser.
Search and multiple languages
The local index works out of the box, and you can swap it for an HTTP or custom backend. Switching language keeps you on the matching page.
Replaceable and extensible
Replace components such as the app bar, the table of contents and the footer, or override CSS variables to adjust the look.

Quick start ​

bash
npm install
npm run dev

Read next:

This site comes in Chinese, English, Japanese, Korean, French and Arabic. Switch with the language button at the bottom of the rail.

GitHub Settings

Search the docs

Type a page title, a component name or words from the text.

Press ⌘/Ctrl + K to open it anytime

Choose a language

EnglishEnglish (United States)العربيةArabic (Saudi Arabia)FrançaisFrench (France)日本語Japanese (Japan)한국어Korean (South Korea)简体中文Chinese (China)

Settings

Color
VariantTonal SpotVibrantFidelityExpressiveMonochromeNeutralRainbowFruit Salad
ContrastDefaultMediumHigh
MotionStandardExpressive
Text directionFollow languageLeft to rightRight to left
Text size100%150%200%