/docs-template

A documentation template build by vitepress

MIT LicenseMIT

English 中文

docs-template

A documentation template build by vitepress

See live example

Features

  • International Multi language supported
  • Search in Chinese (Not perfect)
  • Auto redirect to browser langugage when no language code specified in url
    • / -> /en-US/
    • /Donate -> /en-US/Donate
  • URL search params parsing
    • ?search=%s Once page is loaded, open search box and auto search
    • ?autolang Auto jump to the language provided by navigator.language
      • /zh-CN/changelog -> /en-US/changelog

Q&A

How to add new language support

For example, language ID is ru.

  1. Create folder docs/ru
  2. Add locale config docs/.vitepress/locales/ru.mts
  3. Add locale define in docs/.vitepress/locales.mts 
    const langs = [
	'en-US',
	'zh-CN',
	'ru',
];

...

How to add a new sector

For example, sector name is readme

  1. Create directory docs/readme/
  2. Create index page docs/readme/index.md
  3. Add to nav bar Edit every locale script under docs/.vitepress/locales/ 
    ...

	themeConfig: {
		nav: [
			...
			// Add to nav bar
			{ text: 'Readme', link: `/${lang}/readme/` },
		],
		sidebar: {
			...

			// Auto generate sidebar
			'/zh-CN/readme': buildSidebar(`/${lang}/readme`),
		}
	}

...

How to change base (/ by default)

For example, set base to Third-Person

Just modify .vitepress/config.mts

export default defineConfig({
base: 'Third-Person',

...
});

How to change source root dir (. usually)

For example, change source root to pages

  1. Edit docs/.vitepress/config.mts 
    export default defineConfig({
	srcDir: 'pages',

	...
})
  2. Edit docs/.vitepress/builders.mts 
    export function buildSidebar(dir: string, docsRoot: string = 'pages'): any {

	...