Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/yliaho/vuepress-theme-valle

Blog theme for VuePress
https://github.com/yliaho/vuepress-theme-valle

blog static-site vue vuepress

Last synced: 4 days ago
JSON representation

Blog theme for VuePress

Awesome Lists containing this project

README

        

# vuepress-theme-valle

> Simple [VuePress](https://github.com/vuejs/vuepress) theme with blogging support.

| Screenshot |
| ------------------------------------------------------- |
| ![Screenshot of Valle VuePress theme](./screenshot.png) |

## **Under development, not ready for use!**

This is a work in progress project to see the possible blogging capabilities of VuePress. A lot of stuff is still under development and is not ready to be used in production.

## Installing

* `yarn install vuepress-theme-valle` or `npm install vuepress-theme-valle --save`
* Inside your existing VuePress project, create (if not present) `config.js` inside `.vuepress` folder.
* Add `theme: 'valle'` to the config object.
* That's it! VuePress now uses Valle as its theme.

## Theme Config

Theme specific options in VuePress config.

```javascript
module.exports = {
// The theme uses `title` and `description`
title: 'My Blog',
description: 'My vuesome blog',

themeConfig: {
// Author specific metadata. Used for homepage bio.
author: {
name: 'John Doe',
social: {
facebook: 'url',
twitter: 'url',
linkedin: 'url',
instagram: 'url'
}
},
// defaults to '/posts/' if postDir isn't provided.
postDir: '/posts/'
}
}
```