vuepress-theme-mini

    3.1.1 • Public • Published

    vuepress-theme-mini

    NPM Version License

    Introduction

    A minimal blogging theme of VuePress.

    Demo

    Install

    # NPM registry:
    npm install vuepress-theme-mini -D
    # or
    yarn add vuepress-theme-mini -D
    
    # GitHub registry:
    npm install @wxsms/vuepress-theme-mini -D
    # or
    yarn add @wxsms/vuepress-theme-mini -D

    Usage

    Configurations are extended from Default theme config, with some additions. Noted that not all of the defaults are usable (such as sidebar), since this theme is a minimal design.

    module.exports = {
      // ...
      theme: 'mini',
      themeConfig: {
        hostname: 'https://xxx', // provide to enable sitemap and rss feed generation
        ga: 'xxx', // provide to enable google analysis
        siteName: '...', // site name at navbar
        author: '...', // author name at footer
        // enable navbar and add links
        navbar: true,
        nav: [
          { text: 'home', link: '/' },
          { text: 'about', link: '/about/' }
        ],
        // Waline configurations: https://waline.js.org/reference/client.html
        // note:
        // 1. `el` are already taken care and will be ignored
        // 2. `visitor` is supported
        comment: {
          serverURL: 'https://xxx'
        }
      },
      // ...
    }

    Layouts

    FYI: Custom Layout for Specific Pages

    Default

    Default layout for normal articles that including a comment area.

    Page

    Almost the same as default but without comment.

    Archive

    Display an article archive base on the folder structure or archive param in YAML frontmatter.

    For example: if you place a README.md with layout: Archive inside posts folder, then it will content all articles inside posts folder. You can also place it under root folder with postsDir: '/posts' frontmatter (Regex is supported).

    Pager

    Display and article pager with excerpts, you probably want to use this on the home page.

    • postsDir is also supported here
    • add readMore: false front matter if you don't want the read more button to appear for specify post

    Changelog

    See releases.

    License

    MIT

    Keywords

    none

    Install

    npm i vuepress-theme-mini

    DownloadsWeekly Downloads

    15

    Version

    3.1.1

    License

    MIT

    Unpacked Size

    54.6 kB

    Total Files

    16

    Last publish

    Collaborators

    • wxsm