Skip to content

derbalkon/vuepress-theme-succinct

 
 

Repository files navigation

vuepress-theme-succinct

Vuepress npm License

A slightly opinionated theme for Vuepress

Features

  • Customizable typography: Import and use your favorite web-fonts. Customize font sizes and text-adjustment for body text
  • Dark and light themes: System theme detection with a theme-switcher to set the theme as per the user preference
  • Accessible: Succinct applies tweaks - deeper contrast, better legibility preferences, etc - to improve the readability

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 😄 for more details.

Plugins

This theme has the following plugins built in:

Acknowledgements

Nods to people and projects that made succinct possible.

Releases

No releases published

Packages

No packages published

Languages

  • Vue 67.6%
  • CSS 24.5%
  • JavaScript 7.9%