Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/saberland/saber-theme-minima

A Saber Port of the Default Jekyll Theme: Minima
https://github.com/saberland/saber-theme-minima

jekyll minima saber saber-theme

Last synced: about 2 months ago
JSON representation

A Saber Port of the Default Jekyll Theme: Minima

Awesome Lists containing this project

README

        

# saber-theme-minima

[![npm](https://badgen.net/npm/v/saber-theme-minima)](https://npm.im/saber-theme-minima) [![circleci](https://badgen.net/circleci/github/saberland/saber-theme-minima/master)](https://circleci.com/gh/saberland/saber-theme-minima)

> A Saber Port of the Default Jekyll Theme: Minima

## Install

```bash
yarn add saber-theme-minima
```

In your `saber-config.yml`:

```yml
theme: minima
```

This theme uses the following [Saber plugins](https://github.com/saberland/awesome-saber#plugins):

- `saber-plugin-query-posts`: Inject `posts` to homepage's `page` prop, generate tag pages.
- `saber-plugin-feed`: Generate RSS feed.

```bash
yarn add saber-plugin-query-posts saber-plugin-feed
```

```yml
plugins:
- resolve: saber-plugin-query-posts
- resolve: saber-plugin-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`:

```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:

```yml
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:

```yml
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 for comments:

```yml
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`:

```markdown
---
title: Hello
layout: post
date: 2018-08-12
comments: false
---

Hello World!
```

## License

MIT.