Vitepress Theme Akari Docsv1.0.0GitHubSettingsMore

Icons

The theme uses Material Symbols icons, registered on demand, with no icon font or CDN.

Icons on a set of rounded squares, and strokes from thin to thick

Icons ​

All icons in the theme are Material Symbols. @m3e/icons provides them as SVG paths, and <m3e-icon> displays them. Choosing icons covers styles, fill and size; Using icons covers registration and accessibility requirements.

Features ​

  • Registered on demand: each icon is a separate module. Only icons imported in icons.ts end up in the build output, so the size of the first screen doesn't depend on the total number of icons.
  • No network needed: icons are installed with @m3e/icons and render as inline SVG. There are no font files, and no flash of text before an icon font loads.
  • Follows the theme: icons use currentColor, so they take their color from the M3 color role of the component they sit in, and follow changes to light and dark mode, contrast and dynamic color automatically.
  • Outlined and filled: every icon has a filled form, and the filled attribute switches between the two. The selected item in the navigation uses it to mark the current location.

Icons in the theme ​

LocationIcon sourceNotes
rail and mobile drawerThe icon of each category in sidebar.categories in the shared configDefaults to category; the current category shows the filled form
App barBuilt into the themeMenu, search, more, settings and social links
Floating action buttonsBuilt into the themeBack to top is keyboard_arrow_up; the table of contents is format_list_bulleted
Bottom of the railBuilt into the themeThe appearance button's icon changes with the mode; the language button is translate
Article body<m3e-icon> in MarkdownMust be registered in icons.ts first

Pages in this group ​

These three pages are a set of parallel pages: they appear as a single "Icons" item in the sidebar, and the tab bar at the top of the page switches between them. They are index.md, choosing.md and using.md in the styles/icons/ folder. To write pages like these, see Writing pages.

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%