Files
zhdiary/themes/blog/README.md
T
2019-08-12 01:13:27 +07:00

54 lines
1.2 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# Cogear.JS theme **blog**
![screenshot](https://github.com/codemotion/cogear-theme-blog/raw/master/screenshot.jpg)
Theme with blog posts on the home page.
Simple responsive design. Posts tags support with navigation and pagination.
# Installation
You need to install [`cogear-plugin-blog`](https://github.com/codemotion/cogear-plugin-blog) to use this theme.
Go to the site folder and install theme with command:
```bash
yarn add cogear-theme-blog
# or
npm install cogear-theme-blog
```
After that you need to edit your site `config.yaml` to set up installed theme.
```yaml
theme: blog
```
# Configuration
Use `cogear-plugin-blog` options in `./config.yaml`:
``` yaml
title: Blog | Cogear.JS – modern static websites generator
description:
keywords:
theme: blog
blog:
index: "" # Provide posts to index page
regex: "^p/"
tagUri: 'tag'
perPage: 5
pages:
^p/:
layout: post
author:
login: User
avatar: 'https://www.gravatar.com/avatar/400caf343d3bab57ab93f63e21a12be7?s=24'
link: https://cogearjs.org
```
# Usage
You may also want to install in with [`cogear-preset-blog`](https://github.com/codemotion/cogear-preset-blog).
# Docs
More info: [https://cogearjs.org/docs/themes](https://cogearjs.org/docs/themes).