Get Started

This is a normal page, which contains VuePress basics.

Pages

You can add markdown files in your vuepress directory, every markdown file will be converted to a page in your site.

See routingopen in new window for more details.

Content

Every markdown file will be rendered to HTML, then converted to a Vue SFCopen in new window.

VuePress support basic markdown syntax and some extensionsopen in new window, you can also use Vue featuresopen in new window in it.

Configuration

VuePress use a .vuepress/config.js(or .ts) file as site configurationopen in new window, you can use it to config your site.

For client side configurationopen in new window, you can create .vuepress/client.js(or .ts).

Meanwhile, you can also add configuration per page with frontmatteropen in new window.

Layouts and customization

Here are common configuration controlling layout of @vuepress/theme-default:

Check default theme docsopen in new window for full reference.

You can add extra styleopen in new window with .vuepress/styles/index.scss file.

Last Updated:
Contributors: Rubyc