Overview
Vitepress Theme Akari Docs is a documentation theme built with VitePress and @m3e/web.
Features
Color, shape, motion and typography all come from the m3e design tokens and match the official Material 3.
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.
An article can be split into several pages, switched with a tab bar. A page with a hero takes its colors from the image.
Four light and dark modes. Color, variant, contrast, motion, text direction and text size apply instantly and are saved in the current browser.
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.
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 devRead next:
- Installation: creating a repository from the template, requirements and deployment.
- Configuration: shared config and language config.
- Writing pages: new articles, frontmatter and Markdown.
- Layout and app bar, Side navigation: the parts of the theme shell.
This site comes in Chinese, English, Japanese, Korean, French and Arabic. Switch with the language button at the bottom of the rail.