Skip to content

Commit

Permalink
docs: add bundler pages and simplify titles
Browse files Browse the repository at this point in the history
  • Loading branch information
meteorlxy committed Jan 4, 2021
1 parent 88d1ae2 commit 8029abc
Show file tree
Hide file tree
Showing 21 changed files with 78 additions and 71 deletions.
43 changes: 15 additions & 28 deletions docs/.vuepress/configs/navbar/en.ts
Original file line number Diff line number Diff line change
Expand Up @@ -15,39 +15,26 @@ export const en: NavbarConfig = [
text: 'CLI',
link: '/reference/cli.html',
},
{
text: 'Config',
link: '/reference/config.html',
},
{
text: 'Frontmatter',
link: '/reference/frontmatter.html',
},
{
text: 'Built-in Components',
link: '/reference/components.html',
},
{
text: 'Plugin API',
link: '/reference/plugin-api.html',
},
'/reference/config.md',
'/reference/frontmatter.md',
'/reference/components.md',
'/reference/plugin-api.md',
'/reference/theme-api.md',
],
},
{
text: 'Bundler',
children: [
'/reference/bundler/webpack.md',
'/reference/bundler/vite.md',
],
},
{
text: 'Default Theme',
children: [
{
text: 'Config',
link: '/reference/default-theme/config.html',
},
{
text: 'Frontmatter',
link: '/reference/default-theme/frontmatter.html',
},
{
text: 'Built-in Components',
link: '/reference/default-theme/components.html',
},
'/reference/default-theme/config.md',
'/reference/default-theme/frontmatter.md',
'/reference/default-theme/components.md',
],
},
],
Expand Down
48 changes: 16 additions & 32 deletions docs/.vuepress/configs/navbar/zh.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11,43 +11,27 @@ export const zh: NavbarConfig = [
{
text: 'VuePress',
children: [
{
text: '命令行接口',
link: '/zh/reference/cli.html',
},
{
text: '配置',
link: '/zh/reference/config.html',
},
{
text: 'Frontmatter',
link: '/zh/reference/frontmatter.html',
},
{
text: '内置组件',
link: '/zh/reference/components.html',
},
{
text: '插件 API',
link: '/zh/reference/plugin-api.html',
},
'/zh/reference/cli.md',
'/zh/reference/config.md',
'/zh/reference/frontmatter.md',
'/zh/reference/components.md',
'/zh/reference/plugin-api.md',
'/zh/reference/theme-api.md',
],
},
{
text: '打包工具',
children: [
'/zh/reference/bundler/webpack.md',
'/zh/reference/bundler/vite.md',
],
},
{
text: '默认主题',
children: [
{
text: '配置',
link: '/zh/reference/default-theme/config.html',
},
{
text: 'Frontmatter',
link: '/zh/reference/default-theme/frontmatter.html',
},
{
text: '内置组件',
link: '/zh/reference/default-theme/components.html',
},
'/zh/reference/default-theme/config.md',
'/zh/reference/default-theme/frontmatter.md',
'/zh/reference/default-theme/components.md',
],
},
],
Expand Down
8 changes: 8 additions & 0 deletions docs/.vuepress/configs/sidebar/en.ts
Original file line number Diff line number Diff line change
Expand Up @@ -41,9 +41,17 @@ export const en: SidebarConfig = {
'/reference/frontmatter.md',
'/reference/components.md',
'/reference/plugin-api.md',
'/reference/theme-api.md',
],
},
],
'/reference/bundler/': [
{
isGroup: true,
text: 'Bundler Reference',
children: ['/reference/bundler/webpack.md', '/reference/bundler/vite.md'],
},
],
'/reference/default-theme/': [
{
isGroup: true,
Expand Down
11 changes: 11 additions & 0 deletions docs/.vuepress/configs/sidebar/zh.ts
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,17 @@ export const zh: SidebarConfig = {
'/zh/reference/frontmatter.md',
'/zh/reference/components.md',
'/zh/reference/plugin-api.md',
'/zh/reference/theme-api.md',
],
},
],
'/zh/reference/bundler/': [
{
isGroup: true,
text: '打包工具参考',
children: [
'/zh/reference/bundler/webpack.md',
'/zh/reference/bundler/vite.md',
],
},
],
Expand Down
3 changes: 3 additions & 0 deletions docs/reference/bundler/vite.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Vite

> TODO
3 changes: 3 additions & 0 deletions docs/reference/bundler/webpack.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Webpack

> TODO
2 changes: 1 addition & 1 deletion docs/reference/config.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Config Reference
# Config

## Site Config

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/default-theme/config.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Config Reference
# Config

> TODO
2 changes: 1 addition & 1 deletion docs/reference/default-theme/frontmatter.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Frontmatter Reference
# Frontmatter

> TODO
2 changes: 1 addition & 1 deletion docs/reference/frontmatter.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Frontmatter Reference
# Frontmatter

## lang

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/plugin-api.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Plugin API Reference
# Plugin API

Plugins should be used before initialization. The basic options will be handled once the plugin is used:

Expand Down
3 changes: 3 additions & 0 deletions docs/reference/theme-api.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Theme API

> TODO
3 changes: 3 additions & 0 deletions docs/zh/reference/bundler/vite.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Vite

> TODO
3 changes: 3 additions & 0 deletions docs/zh/reference/bundler/webpack.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Webpack

> TODO
1 change: 0 additions & 1 deletion docs/zh/reference/components.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
# 内置组件


## ClientOnly

- 使用:
Expand Down
2 changes: 1 addition & 1 deletion docs/zh/reference/config.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# 配置参考
# 配置

## 站点配置

Expand Down
2 changes: 1 addition & 1 deletion docs/zh/reference/default-theme/config.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# 配置参考
# 配置

> TODO
2 changes: 1 addition & 1 deletion docs/zh/reference/default-theme/frontmatter.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Frontmatter 参考
# Frontmatter

> TODO
2 changes: 1 addition & 1 deletion docs/zh/reference/frontmatter.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Frontmatter 参考
# Frontmatter

## lang

Expand Down
2 changes: 1 addition & 1 deletion docs/zh/reference/plugin-api.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# 插件 API 参考
# 插件 API

插件需要在初始化之前使用。基础配置项会在使用插件时立即被处理:

Expand Down
3 changes: 3 additions & 0 deletions docs/zh/reference/theme-api.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# 主题 API

> TODO

0 comments on commit 8029abc

Please sign in to comment.