Vitepress Theme Akari Docsv1.0.0GitHubSettingsMore

Layout and app bar: API ​

appBar ​

FieldTypeDefaultDescription
titlestringSite titleSite name in the app bar
versionstringNoneVersion label next to the name, such as v1.0.0
logostringThe config's logoBrand image; site paths get base added automatically
showSidebarTogglebooleantrueWhether to show the menu button that opens the navigation drawer on narrow screens
showSettingsTogglebooleantrueWhether to show the settings button; always hidden when settings.enabled is false
socialLinksAkariSocialLink[][]Social links, opened in a new tab

Fields of AkariSocialLink:

FieldTypeDescription
iconstringgithub and npm show built-in brand marks; any other value is used as the name of a registered m3e icon
linkstringURL
labelstringAccessible name and tooltip text of the button, and also its text in the "More" menu

toc ​

FieldTypeDefaultDescription
enabledbooleantrueWhether to show the table of contents (the TOC on the right and the TOC button on narrow screens)
maxDepthnumber3Lists h2 through h{maxDepth}; clamped to 1–6
overlinestringPer language; "On this page"Small heading at the top of the TOC, and the accessible name of the TOC navigation

To turn off the table of contents on a single page, write toc: false in its frontmatter. Headings with the m3e-toc-ignore attribute are left out of the table of contents.

loadingBar ​

FieldTypeDefaultDescription
enabledbooleantrueWhether a progress bar shows at the top of the window while a page loads
FieldTypeDefaultDescription
messagestringPer languageText below the logo and site name in the footer
copyrightstring""Copyright notice at the bottom of the footer; not shown when empty
showPrevNextbooleantrueWhether to show the previous and next page cards of the group at the end of parallel pages
linksAkariFooterLinkGroup[] | falseFrom the navigationLink columns of the footer; by default the first four categories of the navigation, with at most six items per column; false hides them
ts
footer: {
  links: [
    {
      title: "Resources",
      items: [
        { text: "GitHub", link: "https://github.com/OasisAkari/vitepress-theme-akari-docs" },
        { text: "Changelog", link: "/changelog" },
      ],
    },
  ],
},

External links open in a new tab. A group of parallel pages becomes a single item in the link columns.

CSS variables ​

Override them in your site styles, for example on :root:

VariableDefaultPurpose
--akari-doc-radius28pxCorner radius of the document surface and the footer surface
--akari-doc-padding32pxPadding of the surfaces, and the gap between the content and the TOC
--akari-doc-top-space32pxDistance between the document surface and the app bar
--akari-doc-max-width1280pxMaximum width of the content and TOC inside the surface; the footer content uses the same width
--akari-doc-text-measure760pxMaximum line length of paragraphs, lists, blockquotes and callouts
--akari-doc-text-offset22pxHow far paragraphs are indented relative to headings
--akari-doc-toc-offset128pxHow far below the app bar the TOC sticks
--akari-toc-width208pxWidth of the TOC
--akari-doc-gap16pxDistance between a heading and the app bar after an anchor jump
--akari-doc-surface-color--md-sys-color-surfaceBackground color of the document surface and the footer surface; set it inside m3e-theme (for example on .akari-main) so the color tokens resolve
--akari-doc-divider-strength30%Strength of the rail divider and of the surface outline after scrolling
--akari-wavy-divider-color--md-sys-color-outline-variantColor of the wavy divider above the footer
--akari-doc-app-bar-height64pxHeight of the app bar; read-only, used to work out sticky positions
--akari-doc-rail-width96pxWidth of the rail; read-only
--akari-loading-bar-height4pxHeight of the loading bar
--akari-loading-bar-color--md-sys-color-primaryColor of the loading bar
css
:root {
  --akari-doc-radius: 24px;
  --akari-doc-max-width: 1440px;
}

.akari-main {
  --akari-doc-surface-color: var(--md-sys-color-surface-container-lowest);
}

Page state ​

MarkerWhereMeaning
data-akari-readyhtmlThe m3e components have finished registering
data-akari-scrolledhtmlThe document surface has scrolled under the app bar
akari-tabs-pinnedClass name on htmlThe tab bar of parallel pages is held below the app bar
data-akari-page-titleElementThe page title that the app bar title swap follows; by default the h1 of the content or the title in the hero
Element idContent
akari-doc-contentContent container, which the TOC reads its headings from; the exported AKARI_CONTENT_ID
akari-sidebarMobile navigation drawer; AKARI_SIDEBAR_ID
akari-settingsSettings panel; AKARI_SETTINGS_ID

Replacing components ​

You can replace the app bar, the desktop navigation, the mobile drawer, the hero, the TOC, the pager cards, the footer and the content container; see Extending the theme.

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%