Sign Up for Free

RunKit +

Try any Node.js package right in your browser

This is a playground to test code. It runs a full Node.js environment and already has all of npm’s 1,000,000+ packages pre-installed, including vuepress-theme-mini with all npm packages installed. Try it out:

var vuepressThemeMini = require("vuepress-theme-mini")

This service is provided by RunKit and is not affiliated with npm, Inc or the package authors.

vuepress-theme-mini v1.4.1

A minimal blogging theme of VuePress.

vuepress-theme-mini

NPM Version License

Introduction

A minimal blogging theme of VuePress.

Example

Install

NPM:

npm install vuepress-theme-mini --save-dev
# or
yarn add vuepress-theme-mini --dev

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: {
    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/' }
    ],
    // valine configurations: https://valine.js.org/configuration.html
    // note that `el` and `path` are already taken care and will be ignored
    valine: {
      appId: '[your appId]',
      appKey: '[your appKey]'
    }
  },
  // ...
}

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.

ArticleList

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

For example: if you place a README.md with layout: ArticleList inside posts folder, then it will content all articles inside posts folder. You can also place it under root folder with articleIndex: '/posts' frontmatter.

Changelog

See releases.

License

MIT

Metadata

RunKit is a free, in-browser JavaScript dev environment for prototyping Node.js code, with every npm package installed. Sign up to share your code.
Sign Up for Free