Microflash / vuepress-theme-succinct

A slightly opinionated theme for Vuepress
https://succinct.mflash.dev
MIT License
30 stars 3 forks source link
documentation-tool vuepress vuepress-theme

vuepress-theme-succinct

Vuepress npm License

A slightly opinionated theme for Vuepress

Features

Get Started

Add the dependency to your existing Vuepress project via Yarn or NPM.

yarn add -D vuepress-theme-succinct
npm install -D vuepress-theme-succinct

Update .vuepress/config.js as follows.

module.exports = {
  theme: 'vuepress-theme-succinct',
  globalUIComponents: [
    'ThemeManager'
  ],
}

ThemeManager provides theme-switching functionality across the app.

Note that you can also use the shorthand name for the theme.

module.exports = {
  theme: 'succinct',
  globalUIComponents: [
    'ThemeManager'
  ],
}

Check out the documentation built with Vuepress and Succinct :smile: for more details.

Contribute

Contributions from the community are welcome and deeply appreciated. Refer to the contribution guidelines to get started.

Plugins

This theme has the following plugins built in:

Acknowledgements

Nods to people and projects that made succinct possible.