https://github.com/FriendlyUser/vuepress-theme-cool-starter

Starter project for vuepress theme cool
https://github.com/FriendlyUser/vuepress-theme-cool-starter

documentation vuepress vuepress-theme vuepress-theme-cool

Last synced: about 1 month ago
JSON representation

Starter project for vuepress theme cool

• Host: GitHub
• URL: https://github.com/FriendlyUser/vuepress-theme-cool-starter
• Owner: FriendlyUser
• License: mit
• Created: 2018-11-12T21:46:46.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2023-04-25T04:05:34.000Z (about 2 years ago)
• Last Synced: 2025-04-03T11:15:46.679Z (about 1 month ago)
• Topics: documentation, vuepress, vuepress-theme, vuepress-theme-cool
• Language: Shell
• Homepage: https://friendlyuser.github.io/vuepress-theme-cool-starter
• Size: 8.32 MB
• Stars: 77
• Watchers: 1
• Forks: 35
• Open Issues: 21
• Metadata Files:
  • Readme: ReadMe.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

• awesome-starred - FriendlyUser/vuepress-theme-cool-starter - Starter project for vuepress theme cool (documentation)

README

        
---

home: true

actionText: Get Started →

actionLink: /custom-components/

features:

- title: Admonitions and Tables

  details: Uses google material icons and sortable tables

- title: Charts and Math

  details: Leverage chartjs and katex 

- title: Diagramming tools

  details: Integrated with mermaid and plantuml

footer: MIT Licensed | Copyright © 2020-present David Li

---

## Disclaimer

As of `[email protected]` I cannot get this starter template running with vuepress installed globally, it throws an error message for me.

## ReadMe

This is an example of how to use the `vuepress-theme-cool` vuepress theme, look into docs for example files.

## Installation and Running

To install:

`npm install`

To run with vuepress installed locally:

`npm install vuepress --save-dev`

`npm run docs:dev`

## Customization

Most of the customization is done in `config.js`, automatic navbar and sidebar navigation is available in `config-other.js`

Some other good vuepress examples can be found at [vuepress-examples](https://vuepress-examples.netlify.com/)

If you would like to motivate me to spend more time improving open source projects please consider donating.

[![paypal](https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=Z6M6Y83D3URSU&item_name=Motivating+me+to+continue+to+produce+open+source+projects&currency_code=CAD)