https://github.com/laoqiren/yohe
:smiling_imp: powerful static blog generator
https://github.com/laoqiren/yohe
blog static-site-generator
Last synced: about 1 month ago
JSON representation
:smiling_imp: powerful static blog generator
- Host: GitHub
- URL: https://github.com/laoqiren/yohe
- Owner: laoqiren
- License: mit
- Created: 2017-10-02T16:11:26.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2017-10-13T03:25:08.000Z (over 7 years ago)
- Last Synced: 2024-11-11T09:44:01.755Z (7 months ago)
- Topics: blog, static-site-generator
- Language: JavaScript
- Homepage: http://luoxia.me/yohe_site/
- Size: 102 KB
- Stars: 69
- Watchers: 6
- Forks: 8
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-github-star - yohe
README
# Yohe
[](https://www.npmjs.com/package/yohe)
[](https://github.com/laoqiren/yohe)
[](https://github.com/laoqiren/yohe)
a static blog generator, powered by [Node.js](https://nodejs.org). Yohe means that you will say "Wow, so cute" after you tried it.
online demo: [http://luoxia.me/yohe_site/](http://luoxia.me/yohe_site/)
[中文文档](https://github.com/laoqiren/yohe/blob/master/CN.md)
## Features
* simple and fast static blog generator.
* local server to preview the blog.
* Customizable information and themes.
* create new custom pages, CuSTomizable navigation menu.
* tags,categories,pages,archives,etc.
* github comment(powered by gitment).
* filter specially categories to not be shown on the posts list
## Installation
```
$ npm install yohe -g
```
## Quick Start
**Get help**
```
$ yohe --help
```
**Setup your blog**
```
$ yohe init myblog
$ cd myblog
```
the command will init the blog dir, include initial theme,posts,custom pages dir,and initial config fle.
**Create a new post**
```
$ yohe new
```
the command will create `.md` file in `source/_posts`,edit it to start writting.
**Generate static files**
```
$ yohe build
```
the command will generate your blog to dir `public`
**Preview the blog**
```
$ yohe server
```
the command will start a local static server to serve the `public` files. The port and subdir information can be edited at `config.json`.
**new custom pages**
```
$ yohe page
```
the command will create `.md` file in `source/_extra` dir, the initial layout of the new page is `about`.
## config.json
```js
{
"basic": {
"title": "My Blog", // the title of your blog
"author": "laoqiren", // the author of the blog
"description": "I Love Coding",
"root": "" // the root of the site ，e.g. set root to be "/yohe_site" if your blog is at "http://luoxia.me/yohe_site"
},
"theme": {
"themeName": "default", // name of the theme.
"highlightTheme": "railscasts", // code highlight syle, all available styles refer to "https://github.com/isagalaev/highlight.js/tree/master/src/styles"
"per_page": 6,// number of posts per page
"filter": ["Life","Secret"], // filter some special categories to not be shown
"navPages": [ // custom pages
{
"title": "Tags",
"url": "/tags"
},
{
"title": "About Me",
"url": "/about"
},
{
"title": "Life",
"url": "/categories/life/"
}
],
"reward": { // config about reward
"enabled": true,
"imgName": "alipay.jpg", // reward QR Code images e.g. alipay.jpg
"words": "support me" // custom reward words
}
},
"server": {
"port": 3000 // the port of local static server
},
"gitment": { // gitment config, refer to ”https://github.com/imsun/gitment“
"owner": "",
"repo": "",
"oauth": {
"client_id": "",
"client_secret": ""
}
}
}
```
## post pattern
follow the example below:
```
---
title: Cluster
date: 2016-11-27
tags: [Cluster,process]
layout: post
comment: true
categories: Nodejs
---
```
**tips:** initial `layout` is `post`, and initial `comment` is `true`.
## How to publish
`Yohe` will generate your blog to dir `public`, you can use different ways to serve `public` dir.
## How to develop themes
### layouts:
```
├── about.html // layout of about page(required)
├── index.html // layout of index page(required)
├── list.html // posts list page of specially categories&tags(required)
├── post.html // layout of post's detail page(Can rename)
└── tags.html // layout of tags cloud(required)
└── ... // custom layouts
```
### Variables:
**basic variables:**
Variable | Content
------------- | -------------
config | configs Object, refer to `config.json`
tags | Array of tags. For each: `tag.name`,`tag.posts`(Array),`tag.url`
categories | Array of categories. For each: `category.name`, `category.posts`,`category.url`
archives | Array of archives' posts(to show posts list of particular date). For each: `archive.name`,`archive.posts`
archivesList | Array of archives' informations. For each: `archive.archiveTag`,`archive.arrOfDate`,`archive.url`
**special variables:**
Page | Variables
------------- | -------------
post.html | `post`: `post.title`, `post.date`, `post.categories`, `post.tags`, `post.content`
list.html | `title`(the title of concrete tag or category or archive),`posts`(Array of posts after filtered),`pageNumber`(Number of page),`sumpages`(Sum of pages), `flag`("tags" or "categories" or archives")
about.html | `content`: the content of `about.md` or other extra pages' `.md` file.
### assets:
the static resources like `.js`,`.css` should be in dir `assets`
## Other tips
* To setup your own logo, replace `assets/images/logo.png` with your own(name should also be `logo.png`)
* About page is `source/_about/about.md`
* To implement `blog in blog`, filter some special categories
* To avoid errors, replace space with `-` of post name and category name.
## TODOs
* beautify default theme
* analysis,etc
* complex config
## LICENSE
MIT.