docs: adjust the content a bit

pull/151/head
Kia King Ishii 5 years ago
parent ca212da7c3
commit bf77594b7d

@ -37,8 +37,8 @@ function getGuideSidebar() {
{ text: 'Getting Started', link: '/guide/getting-started' }, { text: 'Getting Started', link: '/guide/getting-started' },
{ text: 'Configuration', link: '/guide/configuration' }, { text: 'Configuration', link: '/guide/configuration' },
{ text: 'Markdown Extensions', link: '/guide/markdown' }, { text: 'Markdown Extensions', link: '/guide/markdown' },
{ text: 'Customization', link: '/guide/customization' },
{ text: 'Frontmatter', link: '/guide/frontmatter' }, { text: 'Frontmatter', link: '/guide/frontmatter' },
{ text: 'Customization', link: '/guide/customization' },
{ text: 'Deploying', link: '/guide/deploy' } { text: 'Deploying', link: '/guide/deploy' }
] ]
} }

@ -2,7 +2,7 @@
Any Markdown file that contains a YAML frontmatter block will be processed by [gray-matter](https://github.com/jonschlinkert/gray-matter). The frontmatter must be at the top of the Markdown file, and must take the form of valid YAML set between triple-dashed lines. Example: Any Markdown file that contains a YAML frontmatter block will be processed by [gray-matter](https://github.com/jonschlinkert/gray-matter). The frontmatter must be at the top of the Markdown file, and must take the form of valid YAML set between triple-dashed lines. Example:
```markdown ```md
--- ---
title: Docs with VitePress title: Docs with VitePress
editLink: true editLink: true
@ -13,7 +13,7 @@ Between the triple-dashed lines, you can set [predefined variables](#predefined-
Heres an example of how you could use it in your Markdown file: Heres an example of how you could use it in your Markdown file:
```markdown ```md
--- ---
title: Docs with VitePress title: Docs with VitePress
editLink: true editLink: true
@ -26,13 +26,13 @@ Guide content
## Alternative frontmatter Formats ## Alternative frontmatter Formats
VuePress also supports JSON frontmatter syntax, starting and ending in curly braces: VitePress also supports JSON frontmatter syntax, starting and ending in curly braces:
``` ```json
--- ---
{ {
"title": "Blogging Like a Hacker", "title": "Blogging Like a Hacker",
"editLink": "true" "editLink": true
} }
--- ---
``` ```
@ -63,11 +63,8 @@ head:
- name: keywords - name: keywords
content: super duper SEO content: super duper SEO
--- ---
``` ```
## Predefined Variables Powered By Default Theme
### navbar ### navbar
- Type: `boolean` - Type: `boolean`
@ -85,6 +82,6 @@ You can decide to show the sidebar on a specific page with `sidebar: auto` or di
### editLink ### editLink
- Type: `boolean` - Type: `boolean`
- Default: `siteData.editLinks` - Default: `undefined`
Define if this page should include an edit link. Define if this page should include an edit link.

Loading…
Cancel
Save