https://github.com/alstormyk/saber-theme-vuepress
Vuepress theme for Saber.
https://github.com/alstormyk/saber-theme-vuepress
markdown saber saber-theme vue vuepress
Last synced: 15 days ago
JSON representation
Vuepress theme for Saber.
- Host: GitHub
- URL: https://github.com/alstormyk/saber-theme-vuepress
- Owner: alstormyk
- License: mit
- Created: 2019-03-29T08:38:48.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2019-04-14T14:05:24.000Z (about 6 years ago)
- Last Synced: 2025-04-01T14:38:00.571Z (about 1 month ago)
- Topics: markdown, saber, saber-theme, vue, vuepress
- Language: JavaScript
- Homepage: https://saber-theme-vuepress.netlify.com/
- Size: 4.97 MB
- Stars: 6
- Watchers: 0
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# saber-theme-vuepress
[](https://npm.im/saber-theme-vuepress)
> A Saber Port of the Default Vuepress Theme.
## Install
```bash
yarn add saber-theme-vuepress
```
In your `saber-config.yml`:
```yml
theme: vuepress
```
This theme works best with following plugins:
- `saber-plugin-query-posts`: Inject `posts` to homepage's `page` prop, generate tag pages
```bash
yarn add saber-plugin-query-posts markdown-it-div
```
```yml
plugins:
- resolve: saber-plugin-query-posts
```
and markdown-it-div
```yml
markdown:
plugins:
- resolve: markdown-it-div
```
## Layouts
- `home`: Setup just like the Vuepress home page. All fields are populated from saber-config.yml.
- `post`: For individual blog posts.
- `blog`: A page to show all your posts.
- `page`: For normal pages with a sidebar.
- `default`: For any other pages without a sidebar.
## Site Config
Configure site title, description etc in your `saber-config.yml`:
```yml
siteConfig:
title: My Site
description: About this website.
author: My Name
email: [email protected]
```
## Theme Config
### Navbar
Configure `nav` to show a set of links in header and optional repository link:
```yml
themeConfig:
nav:
- text: Home
link: /
- text: About
link: /about.html
repo:
- site: github
name: your name
```
### Home Page
Configure a home page at ./pages/index.md:
```yml
---
layout: home
heroImage: logo.jpg
heroTitle: Hello
heroDescription: Welcome to saber-theme-vuepress
actionText: Get Started →
actionLink: /about.html
features:
- title: Title One
details: Details for title one.
- title: Saber-Powered
details: With Saber, static rendering with Vue.js is easier now than ever.
- title: Title Three
details: Details for title three.
footer: Footer info goes here.
---
```
## License
MIT.