gh-pages
1import {defineConfig} from 'vitepress'
2
3// https://vitepress.dev/reference/site-config
4export default defineConfig({
5 base: '/zx/',
6 outDir: 'docs',
7 cleanUrls: true,
8 title: 'google/zx',
9 titleTemplate: ':title | google/zx',
10 description: 'A tool for writing better scripts',
11 head: [
12 ['link', {rel: 'apple-touch-icon', sizes: '180x180', href: '/zx/img/favicons/apple-touch-icon.png'}],
13 ['link', {rel: 'icon', type: 'image/png', sizes: '32x32', href: '/zx/img/favicons/favicon-32x32.png'}],
14 ['link', {rel: 'icon', type: 'image/png', sizes: '16x16', href: '/zx/img/favicons/favicon-16x16.png'}],
15 ['link', {rel: 'mask-icon', href: '/zx/img/favicons/safari-pinned-tab.svg', color: '#3a0839'}],
16 ['link', {rel: 'shortcut icon', href: '/zx/img/favicons/favicon.ico'}],
17 ['meta', {name: 'og:image', content: '/zx/img/og-image.png'}],
18 ['meta', {name: 'twitter:image', content: '/zx/img/og-image.png'}],
19 ],
20 themeConfig: {
21 logo: '/img/logo.svg',
22 // https://vitepress.dev/reference/default-theme-config
23 nav: [
24 {text: 'Home', link: '/'},
25 {text: 'Docs', link: '/getting-started'},
26 {
27 text: 'v8',
28 items: [
29 {text: 'v8', link: '/migration-from-v7'},
30 {text: 'v7', link: '/v7/api'},
31 ],
32 },
33 ],
34
35 sidebar: {
36 '/': [
37 {
38 text: 'Docs',
39 items: [
40 {text: 'Getting Started', link: '/getting-started'},
41 {text: 'Setup', link: '/setup'},
42 {text: 'API Reference', link: '/api'},
43 {text: 'CLI Usage', link: '/cli'},
44 {text: 'Configuration', link: '/configuration'},
45 {text: 'Process Promise', link: '/process-promise'},
46 {text: 'Contribution Guide', link: '/contribution'},
47 {text: 'Migration from v7', link: '/migration-from-v7'},
48 ],
49 },
50 {
51 text: 'FAQ',
52 link: '/faq',
53 items: [
54 {text: 'Quotes', link: '/quotes'},
55 {text: 'TypeScript', link: '/typescript'},
56 {text: 'Markdown Scripts', link: '/markdown-scripts'},
57 {text: 'Known Issues', link: '/known-issues'},
58 ],
59 },
60 ],
61
62 '/v7/': [
63 {
64 text: 'Docs (v7)',
65 items: [
66 {text: 'Getting Started', link: '/v7/getting-started'},
67 {text: 'Process Promise', link: '/v7/process-promise'},
68 {text: 'API Reference', link: '/v7/api'},
69 {text: 'Configuration', link: '/v7/configuration'},
70 {text: 'CLI Usage', link: '/v7/cli'},
71 ],
72 },
73 {
74 text: 'FAQ',
75 link: '/v7/faq',
76 items: [
77 {text: 'Quotes', link: '/v7/quotes'},
78 {text: 'TypeScript', link: '/v7/typescript'},
79 {text: 'Markdown Scripts', link: '/v7/markdown-scripts'},
80 {text: 'Known Issues', link: '/v7/known-issues'},
81 ],
82 },
83 ],
84 },
85
86 socialLinks: [
87 {icon: 'github', link: 'https://github.com/google/zx'},
88 ],
89
90 editLink: {
91 pattern: 'https://github.com/google/zx/blob/gh-pages/:path',
92 },
93
94 footer: {
95 message: 'Disclaimer: This is not an officially supported Google product.',
96 },
97
98 search: {
99 provider: 'local',
100 },
101 },
102})