1.0.5 • Published 5 years ago

vuepress-theme-kim v1.0.5

Weekly downloads
2
License
MIT
Repository
github
Last release
5 years ago

vuepress-theme-kim

https://img.shields.io/badge/vuepress-1.x-brightgreen.svgnpm.iovaline

  1. It's a vuepress theme aimed at adding the comments, reading quantity statistics function , page-information and other features required for blogging, suitable for vuepress 1.x;
  2. The theme itself is modified based on the default theme of the vuepress;
  3. You can open https://jinjun1994.github.io/Frontend-Knowledge-Base/ to see it.

Preview

Home Page

npm.io

Article Page

npm.io

Installation and use

  1. Install

    npm install vuepress-theme-kim -dev--save
    
    # or
    
    yarn add vuepress-theme-kim
  2. Use

    // 修改 /docs/.vuepress/config.js
    
    module.exports = {
      theme: 'kim'
    }  

Comment(valine)

Theme with a built-in valine comments, if you want to open this function, only configure your config.js

// change /docs/.vuepress/config.js

module.exports = {
  theme: 'kim',
  themeConfig: {
    // valine
    valineConfig: {
      appId: '...',// your appId
      appKey: '...', // your appKey
    }
  }  
}  

Get APP_ID and APP_Key

Valine is a third-party comment module,https://valine.js.org/en/index.html

Click here to register or login in leancloud.

Click here Create new application in Leancloud, and you will get APP ID/APP Key.

Create new classes in your application : Comment Counter

page-information

page-title

Add page information when writing articles

---
{
author: jinjun,
title: 基础知识,
date: 2018/11/13,
}
---

You can learn how to add Front Matter from this page.Front Matter

you can add default author like blow.If you don't add author in Front Matter,the default author will show.

// change /docs/.vuepress/config.js
module.exports = {
  theme: 'kim',
  themeConfig: {
    author: 'jinjun'     // default author
    // valine
    valineConfig: {
      appId: '...',// your appId
      appKey: '...', // your appKey
    }
  }  
}