vuepress-theme-kalisio

This is a simple VuePress theme for Kalisio projects.

This theme extends the default VuePress theme in order to provides additional functionalities such as diagramming and mapping. Read this section to understand theme inheritance.

In addition, the theme includes the following plugins:

• back-to-top
• paw
• kano
• mermaid.js

Installation

You can install it with

yarn add -D https://github.com/kalisio/vuepress-theme-kalisio#<version>

And then you just need to register the theme in your .vuepress/config.js:

module.exports = {
    // ...
    theme: 'kalisio',
    // ...
}

Usage

Overriding the Banner

The Banner component provides two props, image, slogan and link, that allows you to override the default values which are respectively our logo, our slogan and the url to our website.

In your config.js file, add the following object in the themeConfig object:

banner: {
  image: 'path to your image',
  slogan: 'your slogan',
  link: 'your url'  // you can also use '#' to provide a null link
}

Overriding the palette

Please, report to this section.

Contributing

Found a bug ? Missing a Feature ? Want to contribute ? check out our contribution guidelines for details

Authors

This project is sponsored by

License

This project is licensed under the MIT License - see the license file for details