From 136a56e74dbf75f65bd8e634a1349c281641af8c Mon Sep 17 00:00:00 2001 From: Kia King Ishii Date: Wed, 25 Nov 2020 19:33:01 +0900 Subject: [PATCH] docs: add basic config reference --- docs/.vitepress/config.js | 9 +++++-- docs/config/basics.md | 57 +++++++++++++++++++++++++++++++++++++++ docs/config/index.md | 3 --- 3 files changed, 64 insertions(+), 5 deletions(-) create mode 100644 docs/config/basics.md delete mode 100644 docs/config/index.md diff --git a/docs/.vitepress/config.js b/docs/.vitepress/config.js index 81297dc3..10e44a51 100644 --- a/docs/.vitepress/config.js +++ b/docs/.vitepress/config.js @@ -13,7 +13,7 @@ module.exports = { nav: [ { text: 'Guide', link: '/' }, - { text: 'Config Reference', link: '/config/' }, + { text: 'Config Reference', link: '/config/basics' }, { text: 'Release Notes', link: 'https://github.com/vuejs/vitepress/releases' @@ -51,5 +51,10 @@ function getGuideSidebar() { } function getConfigSidebar() { - return [{ text: 'Config Reference', link: '/config/' }] + return [ + { + text: 'App Config', + children: [{ text: 'Basics', link: '/config/basics' }] + } + ] } diff --git a/docs/config/basics.md b/docs/config/basics.md new file mode 100644 index 00000000..b9b03a33 --- /dev/null +++ b/docs/config/basics.md @@ -0,0 +1,57 @@ +# App Config: Basics + +## base + +- Type: `string` +- Default: `/` + +The base URL the site will be deployed at. You will need to set this if you plan to deploy your site under a sub path, for example, GitHub pages. If you plan to deploy your site to `https://foo.github.io/bar/`, then you should set base to `'/bar/'`. It should always start and end with a slash. + +The `base` is automatically prepended to all the URLs that start with `/` in other options, so you only need to specify it once. + +```js +module.exports = { + base: '/base/' +} +``` + +## lang + +- Type: `string` +- Default: `en-US` + +The `lang` attribute for the site. This will render as a `` tag in the page HTML. + +Note that the `lang` attribute will only be added when building the site via `vitepress build`. You will not see this rendered during `vitepress dev`. + +```js +module.exports = { + lang: 'en-US' +} +``` + +## title + +- Type: `string` +- Default: `VitePress` + +Title for the site. This will be the prefix for all page titles, and displayed in the navbar. + +```js +module.exports = { + title: 'VitePress' +} +``` + +## Description + +- Type: `string` +- Default: `A VitePress site` + +Description for the site. This will render as a `` tag in the page HTML. + +```js +module.exports = { + title: 'A VitePress site' +} +``` diff --git a/docs/config/index.md b/docs/config/index.md deleted file mode 100644 index 17e6b881..00000000 --- a/docs/config/index.md +++ /dev/null @@ -1,3 +0,0 @@ -# Config Reference - -Coming soon...