A minimal blogging theme of VuePress.
# 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
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/' }
],
// 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]'
}
},
// ...
}
FYI: Custom Layout for Specific Pages
Default layout for normal articles that including a comment area.
Almost the same as default but without comment.
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.
Display and article pager with excerpts, you probably want to use this on the home page.
See releases.
MIT