Vuepress Theme Cool screenshot

Vuepress Theme Cool

Author Avatar Theme by Friendlyuser
Updated: 17 Sep 2022
60 Stars

A custom vuepress theme with mermaid and plantuml, katex and vue components.

Categories

Overview

The Personal Documentation Theme for VuePress is a theme designed for personal documentation. It includes libraries for markdown-based diagramming tools, sortable/filterable table components, and chart rendering using Chart.js and vue-chartkick.

Features

  • Markdown-based diagramming tools
  • Sortable/filterable table components
  • Chart rendering using Chart.js and vue-chartkick

Installation

To install the Personal Documentation Theme for VuePress, follow these steps:

  1. Make sure you have VuePress v1 installed. If not, install it by running the following command:
yarn global add vuepress@next
  1. Get the latest version of the theme.

  2. Set up the .vuepress/config.js file. Here is a minimal setup:

module.exports = {
  theme: 'personal-documentation',
}
  1. If you are adding VuePress to your local project, set up the package.json file and make sure your file directory follows the appropriate structure.

For more information, please refer to the official VuePress migration guide.

Summary

The Personal Documentation Theme for VuePress is a theme designed for personal documentation. It includes markdown-based diagramming tools, sortable/filterable table components, and chart rendering using Chart.js and vue-chartkick. To install the theme, make sure you have VuePress v1 installed and follow the provided installation steps.