Theme Config

Theme configuration allows you to customize the theme. You can configure the theme by adding themeConfig to the configuration file:

import { defineConfig } from 'vitepress-theme-niansi'

export default defineConfig({
  title: 'Niansi',
  clearUrls: true,
  
  // themeConfig here
  themeConfig: {
    author: '廿四',
    logo: '/niansi-logo.svg',
    // ...
  }
})

New ​

author New ​

• Type：string

The author name, displayed at the top of the article page.

sidebarBgImage New ​

• Type：string

The background image of the sidebar.

tagPath New ​

• Type：string
• Default：/tags/

The path to the tags page.

categoryPath New ​

• Type：string
• Default：/categories/

The path to the categories page.

archivesPath New ​

• Type：string
• Default：/archives/

The path to the archives page.

recentlyUpdated New ​

• Type: string
• Default: Recently Updated

The text for "Recently Updated".

trendingTags New ​

• Type: string
• Default: Trending Tags

The text for "Trending Tags".

hamburgerHome New ​

• Type: string
• Default: Home

The "Home" text in the hamburger menu.

postedMeta New ​

• Type: string
• Default: Posted

The text for the article's publish time.

authorMeta New ​

• Type: string
• Default: By

The text for the article's author.

readMeta New ​

• Type: string
• Default: Read

The text for the article's view count.

categoriesMeta New ​

• Type: string
• Default: post

The text for the article's category.

excerptLength New ​

• Type: number
• Default: 300

The length of the article excerpt.

commentPlugin New ​

• Type: CommentPlugin

The comment plugin configuration。See Comment Plugin Config。

Removed ​

Removed VitePress default configurations

• aside
• darkModeSwitchLabel
• carbonAds
• editLink
• lastUpdated
• sidebarMenuLabel