docs: add section title to all pages

pull/911/head
Joaquín Sánchez Jiménez 3 years ago
parent d6125c5c86
commit 9d4d0a28d8

@ -1,3 +1,7 @@
---
title: App Configs | Config
---
# App Configs
App configs are where you can define the global settings of the site. App configs define fundamental settings that are not only limited to the theme configs such as configuration for "base directory", or the "title" of the site.

@ -1,3 +1,7 @@
---
title: Frontmatter Configs | Config
---
# Frontmatter Configs
Frontmatter enables page based configuration. On every markdown, youre free to add Any settings to override any global app or theme configs. Also, there are configs which you can only define in Frontmatter.

@ -1,3 +1,7 @@
---
title: Introduction | Config
---
# Introduction
Place your configuration file at `.vitepress/config.js`. This is where all VitePress-specific files will be placed.

@ -1,3 +1,7 @@
---
title: Theme Configs | Config
---
# Theme Configs
Theme configs let you customize your theme. You can define theme configs by adding `themeConfig` key to the config file.

@ -1,3 +1,8 @@
---
title: API Reference | Writing
next: Theme Introduction | Theme
---
# API Reference
VitePress offers several built in API to let you access app data. VitePress also comes with few built-in component that can be used globally.

@ -1,3 +1,7 @@
---
title: Asset Handling | Writing
---
# Asset Handling
All Markdown files are compiled into Vue components and processed by [Vite](https://github.com/vitejs/vite). You can, **and should**, reference any assets using relative URLs:

@ -1,3 +1,7 @@
---
title: Configuration | Inroduction
---
# Configuration
Without any configuration, the page is pretty minimal, and the user has no way to navigate around the site. To customize your site, let's first create a `.vitepress` directory inside your docs directory. This is where all VitePress-specific files will be placed. Your project structure is probably like this:

@ -1,3 +1,8 @@
---
title: Deploying | Inroduction
next: Markdown Extensions | Writing
---
# Deploying
The following guides are based on some shared assumptions:

@ -1,3 +1,7 @@
---
title: Frontmatter | Writing
---
# Frontmatter
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:

@ -1,3 +1,7 @@
---
title: Getting Started | Inroduction
---
# Getting Started
This section will help you build a basic VitePress documentation site from ground up. If you already have an existing project and would like to keep documentation inside the project, start from Step 2.

@ -1,3 +1,8 @@
---
title: Markdown Extensions | Writing
prev: Deploying | Inroduction
---
# Markdown Extensions
VitePress comes with built in Markdown Extensions.

@ -1,3 +1,7 @@
---
title: Migration from VitePress 0.x | Migrations
---
# Migration from VitePress 0.x
If you're coming from VitePress 0.x version, there're several breaking changes due to new features and enhancement. Please follow this guide to see how to migrate your app over to the latest VitePress.

@ -1,3 +1,7 @@
---
title: Migration from VuePress | Migrations
prev: Carbon Ads | Theme
---
# Migration from VuePress
## Markdown

@ -1,3 +1,8 @@
---
title: Carbon Ads | Theme
next: Migration from VuePress | Migrations
---
# Carbon Ads
VitePress has built in native support for [Carbon Ads](https://www.carbonads.net/). By defining the Carbon Ads credentials in config, VitePress will display ads on the page.

@ -1,3 +1,7 @@
---
title: Edit Link | Theme
---
# Edit Link
Edit Link lets you display a link to edit the page on Git management services such as GitHub, or GitLab. To enable it, add `themeConfig.editLink` options to your config.

@ -1,3 +1,7 @@
---
title: Footer | Theme
---
# Footer
When the [page layout](./theme-layout) is set to either `home` or `page`, VitePress will display global footer at the bottom of the page. Set `themeConfig.footer` to configure footer content.

@ -1,3 +1,7 @@
---
title: Home Page | Theme
---
# Home Page
VitePress default theme provides a homepage layout, which you can also see used on [the homepage of this site](../). You may use it on any of your pages by specifying `layout: home` in the [frontmatter](./frontmatter).

@ -1,3 +1,8 @@
---
title: Theme Introduction | Theme
prev: API Reference | Writing
---
# Theme Introduction
VitePress comes with its default theme providing many features out of the box. Learn more about each feature on its dedicated page listed below.

@ -1,3 +1,7 @@
---
title: Last Updated | Theme
---
# Last Updated
Documentation coming soon...

@ -1,4 +1,5 @@
---
title: Layout | Theme
layout: doc
---

@ -1,3 +1,7 @@
---
title: Nav | Theme
---
# Nav
The Nav is the navigation bar displayed on top of the page. It contains the site title, global menu links, etc.

@ -1,3 +1,7 @@
---
title: Prev Next Link | Theme
---
# Prev Next Link
You can customize the text of previous and next links. This is helpful if you want to show different text on previous/next links than what you have on your sidebar.

@ -1,3 +1,7 @@
---
title: Search | Theme
---
# Search
Documentation coming soon...

@ -1,3 +1,7 @@
---
title: Sidebar | Theme
---
# Sidebar
The sidebar is the main navigation block for your documentation. You can configure the sidebar menu in `themeConfig.sidebar`.

@ -1,3 +1,7 @@
---
title: Team Page | Theme
---
<script setup>
import { VPTeamMembers } from 'vitepress/theme'
@ -22,7 +26,6 @@ const members = [
}
]
</script>
# Team Page
If you would like to introduce your team, you may use Team components to construct the Team Page. There're 2 ways of using these components. One is to embbed it in doc page, and another is to create a full Team Page.

@ -1,3 +1,7 @@
---
title: Using Vue in Markdown | Writing
---
# Using Vue in Markdown
In VitePress, each markdown file is compiled into HTML and then processed as a Vue Single-File Component. This means you can use any Vue features inside the markdown, including dynamic templating, using Vue components, or arbitrary in-page Vue component logic by adding a `<script>` tag.

@ -1,3 +1,7 @@
---
title: What is VitePress? | Inroduction
---
# What is VitePress?
VitePress is [VuePress](https://vuepress.vuejs.org/)' little brother, built on top of [Vite](https://vitejs.dev/).

Loading…
Cancel
Save