VitePress Theme +

Appearance

Frontmatter ​

Note that the below are in addition to the options from the default theme.

alert ​

  • Type: Boolean || Object

  • Default:

    yaml
    alert: false

  • Example

    yaml
    alert:
  content: VIBES RISING
  type: 'success'
  closeable: false

  • Details:

    Configure the visibility or content of the <Alert> component on a given page.

    You can also configure this globally with config.

  • Type: Boolean || Object

  • Default: false

  • Example

    yaml
    backLink:
  text: '<- Back to blog'
  link: '/blog'

  • Details:

    Sets a backLink in the document footer.

contributors ​

  • Type: Boolean || Object

  • Default:

    yaml
    contributors: true

  • Example

    yaml
    contributors: false

  • Details:

    Configure the visibility or content of the <Contributors> component on a given page.

    This thing has a lot of options so check out this for more info or to just set global contributors.

jobs ​

  • Type: Boolean || Array[Object]

  • Default:

    yaml
    jobs: true

  • Example

    yaml
    jobs:
  - title: Batman
    logo: https://seeklogo.com/images/B/Batman-logo-F8295E46F2-seeklogo.com.png
    link: https://docs.google.com/forms/d/e/1FAIpQLSc2vkesq59BblKo8ZX-R1hKTrHphh1kmsg4FgWV1WH5BKEjHQ/viewform
    company: Wayne Enterprises
    aux: Gotham, Remote

  • Details:

    Configure the visibility or content of the <Jobs> component on a given page.

    You can also configure this globally with config.

mailchimp ​

sponsors ​

  • Type: Boolean || Object

  • Default:

    yaml
    sponsors: true

  • Example

    yaml
    sponsors:
  text: your logo?
  link: https://lando.dev/sponsor
  data:
    - name: stark
      id: stark
      url: https://en.wikipedia.org/wiki/Stark_Industries
      logo: https://upload.wikimedia.org/wikipedia/commons/7/7d/Stark_Industries.png
      type: half
    - name: wayne
      id: wayne
      url: https://en.wikipedia.org/wiki/Wayne_Enterprises
      logo: https://upload.wikimedia.org/wikipedia/commons/3/32/Wayne_Enterprises_%28DC_Comics_fictional_logo%29.png
      type: half

  • Details:

    Configure the visibility or content of the <Sponsors> component on a given page.

    You can also configure this globally with config.

tags ​

  • Type: String || Array[String]

  • Default:

    yaml
    tags:

  • Example

    yaml
    tags:
  - this is a test tag
  - so is this

  • Details:

    Note that this only works for content that is in a collection.

Guides ​

Blog Posts ​

Metadata ​