0.0.6 • Published 2 months ago
@zenphp/doczilla v0.0.6
Doczilla Theme for Vitepress
Doczilla is a documentation theme for Vitepress and Tailwind fanatics.
To use this theme in your own Vitepress project
In your .vitepress/theme/index.ts
:
import { Theme } from '@zenphp/doczilla';
export default Theme;
Customize the configuration inside .vitepress/config.ts
:
import { defineConfigWithTheme } from 'vitepress';
import type { ThemeConfig } from '@zenphp/doczilla';
import config from '@zenphp/doczilla/config';
export default defineConfigWithTheme<ThemeConfig>({
extends: config,
title: 'Project Title',
description: 'Catchy description here ...',
base: '/docs',
srcDir: 'src',
themeConfig: {
logo: {
light: '/logo.svg',
dark: '/logo-dark.svg',
},
nav: [
{ text: 'Docs', link: 'https://example.com/external-link' },
{ text: 'Releases', link: 'https://example.com/external-link' },
{ text: 'Course', link: 'https://example.com/external-link' },
],
githubUrl: 'https://github.com/user/project',
versions: [
{ text: 'v1.0', link: '/docs/1.0' },
{ text: 'v2.0', link: '/docs/2.0', current: true },
],
sidebar: [
{
text: 'Getting Started',
items: [
{ text: 'Installation', link: '/installation' },
{ text: 'Release Notes', link: '/releases' },
{ text: 'Upgrade', link: '/upgrade' },
{ text: 'Support', link: '/support' },
{ text: 'Code of Conduct', link: '/code-of-conduct' },
],
},
],
search: {
provider: 'algolia',
options: {
indexName: '',
appId: '',
apiKey: '',
placeholder: 'Search Docs...',
},
},
},
});