msb-public
/
vitepress
mirror of https://github.com/vuejs/vitepress
2
1
Code Issues Projects Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '27f840ae04'
${ noResults }
vitepress/docs/guide/theme-layout.md

1.6 KiB
Raw Blame History

layout
doc

Layout

You may switch the of each page by setting layout option to the page frontmatter. There are 3 layout options, doc, page, and home. If don't specify the layout otpion, then the page is treated as option set to doc.

---
layout: doc
---

Doc Layout

Option doc is the default layout and it styles the whole Markdown content into "documentation" look. It works by wrapping whole content within vp-doc css class, and applying styles to elements underneath it.

Almost all generic elements such as p, or h2 get special styling. Therefore, keep in mind that if you add any custom HTML inside a Markdown content, those will get affected by those styles as well.

It also provides documentation specific features listed below. These features are only enabled in this layout.

  • Edit Link
  • Prev Next Link
  • Outline
  • Carbon Ads

Page Layout

Option page is treated as "blank page". The Markdown will still be parsed, and all of the Markdown Extensions work as same as doc layout, but it wouldn't apply default styling.

The page layout will let you style everything by you without VitePress theme affecting the markup. This is useful when you want to create your own custom page.

Note that even in this layout, sidebar will still show up if the page has a matching sidebar config.

Home Layout

Option home will generate templated "Home Page". In this layout, you can set extra options such as hero and features to customize the content further. Please visit Theme: Home Page for more details.