Skip to content
No description or website provided.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
example
font/icon
style
.gitignore
.prettierrc.yaml
HomePage.vue
LICENSE
Layout.vue
PostCard.vue
PostPage.vue
README.md
Sidebar.vue
SidebarContainer.vue refactor: Use stylus instead of scss Apr 22, 2019
Tocbar.vue refactor: Use stylus instead of scss Apr 22, 2019
Toolbar.vue
bus.js
package.json
utils.js
yarn.lock

README.md

vuepress-theme-blogue

A VuePress theme made for blog

code style: prettier Version License

This project is under active development. Any feedback or contributions would be appreciated

Live demo

https://ocavue.github.io/

Basic Usage

First of all, your need to have a VuePress project. Your can follow VuePress's official guide to create one. Then you can use one of the following commands to install this theme.

yarn add vuepress-theme-blogue
// or
npm install vuepress-theme-blogue

Project Configuration

Edit .vuepress/config.js to configure this theme. Below is the default configuration.

...
module.exports = {
    ...
    title: "Project Blogue",
    themeConfig: {
        avatarImage: "https://ws2.sinaimg.cn/large/006tKfTcgy1ftrhghh2cgj3074074dfp.jpg",
        debug: false
    }
}
  • title: Your blog's title, will be displayed in the toolbar (AKA navbar).
  • avatarImage: URL string for avatar, will be displayed in the drawer (AKA sidebar).
  • debug: Whether to show site and page metadata at bottom of every page.

Blog Post Configuration

For every markdown file in your VuePress project, you need a front matter on top of the file. The example below uses YAML front matter but other languages are supported too.

---
title: My first blog
date: 2018-07-01
image: https://ws1.sinaimg.cn/large/006tNc79ly1fsxfr3d6eij31kw11x4qq.jpg
---
  • title (required): Your post's title. vuepress-theme-blogue will NOT find H1 title inside your markdown file.
  • date (required): Your post's date. Your need to use YYYY-MM-DD format. vuepress-theme-blogue use post's date to sort, so this field is required.
  • image (optional): Your post's cover image URL.

Your will need README.md and about.md in your docs directory. These two posts will not be displayed on the home page.

Complete Example

See https://github.com/ocavue/vuepress-theme-blogue/tree/master/example

TODO

  • Update vuepress to 1.0
  • Tags
  • Comments
  • Configurable

Contribution

You can’t perform that action at this time.