Giter VIP home page Giter VIP logo

vuepress-theme-inherit's Introduction

vuepress-theme-inherit

The vuepress blog theme inherited from @vuepress/theme-default, supports archiving and tagging functions, and can automatically sort blogs by time.

NPM

https://www.npmjs.com/package/vuepress-theme-inherit

DEMO

https://yasinchan.com
Source code

Install

Note: The following operations can be found in the official document. Please familiarize yourself with the documentation first.

After install and configure the basic vuepress framework, do the following operations:

  1. Install
    yarn add vuepress-theme-inherit
    
  2. Create a /post /tags /archives directory under the /doc directory to load the blog homepage list, tags and archive functions.
    .
    ├── docs
    │   ├── tags
    │   │   └── README.md
    │   ├── archives
    │   │   └── README.md
    │   ├── post
    │   │   └── README.md
    |   |
    
  3. Add the following configration in the config.js to import the theme and generate the navigation bar.
    theme: 'vuepress-theme-inherit',
    themeConfig: {
      nav: [
        ...
        {text: 'blog', link: '/post/'},
        {text: 'tags', link: '/tags/'},
        {text: 'archives', link: '/archives/'},
        ...
      ]
    },
    
  4. Add the following keywords in the blog markdown file Front Matter to let the script sort
    ---
    created: 2020-1-1
    updated: 2020-2-1
    tags: 
      - Configration
      - Technology
      - Life
    ---
    
    Options
    1. created and updated is used to record the creation and editing time of the blog, as well as used to sort the blog homepage (sort rule : update -> created -> no configration).
    2. created also used to sort the archives.
    3. tags is used to filter the tags.
    4. Blog homepage will create the blog list, base on the markdown files you created under the /post directory automatically.
    5. These above functions will be automatically configured without additional operations.
    6. The README.md under the three folders of /archives /tags /post can be accessed through Front Matter to set the relevant page information include title, keywords and descriptions

TODO

  • Pagination
  • Better SEO

vuepress-theme-inherit's People

Contributors

dependabot[bot] avatar yasinchan avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.