akurtaliqi / vuepress-theme-goyave

Vuepress theme for the Goyave documentation

Vuepress Goyave

The Vuepress theme for the Goyave documentation.

Features:

• Dark theme
• Color blindness friendly
• New containers
  • Images in text (left or right)
  • Monospace box (compatible with formatting)
  • Wrapping grid
• Back to top

Installation

npm install --save-dev vuepress-theme-goyave

Set the theme in your vuepress config (.vuepress/config.js):

module.exports = {
    theme: "goyave"
}

Sponsor support

You can provide a list of sponsors to themeConfig in config.js:

becomeSponsorLink: "https://github.com/sponsors/System-Glitch/",
sponsors: [
    {
        name: "Goyave",
        img: "/goyave_banner.png",
        url: "https://goyave.dev"
    }
]

The sponsors will appear at the top of the sidebar if this list is not empty. If the becomeSponsorLink is empty, the "Become a Sponsor" button will not appear.

New containers

Image in text (left)

::: img-row <img :src="$withBase('/image.svg')" height="150" alt="Image description"/>
Lorem ipsum dolor sit amet, consectetur adipiscing elit.
:::

Image in text (right)

::: img-row-right <img :src="$withBase('/image.svg')" height="150" alt="Image description"/>
Lorem ipsum dolor sit amet, consectetur adipiscing elit.
:::

Monospace box

:::vue
Monospace text **compatible** with *formatting*.
:::

Wrapping grid

::: table
[Link 1](#link-1)
[Link 2](#link-2)
[Link 3](#link-3)
[Link 4](#link-4)
[Link 5](#link-5)
[Link 6](#link-6)
:::