saber-theme-paper

0.1.13 • Public • Published

saber-theme-paper

npm

A simple theme like read on a paper.

Demo

Preview

Install

yarn add saber-theme-paper

In your saber-config.yml:

theme: paper

This theme is better working with following plugins:

  • saber-plugin-query-posts: Inject posts to homepage's page prop, generate tag pages
  • saber-plugin-generate-feed: Generate JSON feed at /feed.json.
yarn add saber-plugin-query-posts saber-plugin-generate-feed
plugins:
  - resolve: saber-plugin-query-posts
  - resolve: saber-plugin-generate-feed
    options:
      atomFeed: true

Layouts

  • post: For blog post pages.
  • page: For normal pages.
  • default: For any other pages like homepage and tag pages.

Site Config

Configure site title, description etc in your saber-config.yml:

siteConfig:
  domain: yourdomain.com
  title: yourWebsiteTitle
  description: anything you want to put
  avatar: /youravatar.jpg
  url: https://yourdomain.com
  license:
    text: CC BY-NC-ND 4.0
    link: https://creativecommons.org/licenses/by-nc-nd/4.0/
  pagination:
    prevPage: back
    nextPage: more articles
    prevPost: prev post
    nextPost: next post

Theme Config

Navbar

Configure nav to show a set of links in header:

themeConfig:
  nav:
    - text: Home
      link: /
    - text: About
      link: /about.html

Social

Configure the accounts of your social network to show at the bottom of homepage:

themeConfig:
  social:
    dribbble: username
    facebook: username
    flickr: username
    github: username
    instagram: username
    linkedin: username
    pinterest: username
    twitter: username
    youtube: username
    telegram: username
    microdotblog: username
    googleplus: username
    rss: true

Comments

You can use Disqus:

themeConfig:
  disqus: disqus-short-name
# Note that `siteConfig.url` is required for Disqus
siteConfig:
  url: https://example.com

Comments are only enabled for post layout, to disable comments in specific page, you can use the page attribute comments:

---
title: Hello
layout: post
date: 2018-08-12
comments: false
---
 
Hello World!

License

MIT © GeekPlux

Website · GitHub @geekplux · Twitter @geekplux

Dependencies (6)

Dev Dependencies (8)

Package Sidebar

Install

npm i saber-theme-paper

Weekly Downloads

1

Version

0.1.13

License

MIT

Unpacked Size

36.5 kB

Total Files

17

Last publish

Collaborators

  • geekplux