# Config: Frontmatter

# home

  • Type: boolean
  • Default: false

Declare that current page is homepage:

---
home: true
---

For more details please head Guide > Homepage.

# api

  • Type: boolean
  • Default: false

Declare that current page is api page:

---
api: true
---

For more details please head Guide > API Page.

# toc

  • Type: boolean
  • Default: true

Display table of content at right side, set false to hidden it:

---
toc: false
---
  • Type: boolean
  • Default: true

Display current sidebar at left side, set false to hidden sidebar:

---
sidebar: false
---

See live example.

# sidebarDepth

  • Type: number
  • Default: 1

Set maximum depth of sidebar headers, set 0 to hide headers at it:


  • Type: boolean
  • Default: true

Display current navbar at the top, set false to hidden it:

---
navbar: false
---

# pageEdit

Display page edit at the bottom, set false to hidden it:

---
pageEdit: false
---