Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hacke2/wooden
use markdown to build a static web page
https://github.com/hacke2/wooden
Last synced: 9 days ago
JSON representation
use markdown to build a static web page
- Host: GitHub
- URL: https://github.com/hacke2/wooden
- Owner: hacke2
- Created: 2015-10-21T16:38:53.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2016-02-18T12:14:26.000Z (over 8 years ago)
- Last Synced: 2024-10-12T04:14:14.177Z (about 1 month ago)
- Language: HTML
- Homepage: http://www.hacke2.cn/wooden/
- Size: 620 KB
- Stars: 4
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# wooden
使用markdown来创建你的网页
## 安装
```
npm install wooden -g
```
## 使用步骤
### 创建一个空项目
```
wooden create [dir]
```
这个命名会生成一个空的项目，它包含了四个文件：
* `_post` 你的markdown文件放在这里
* `_layout` 布局文件，在这里我使用的jade
* `assets` 静态资源
现在你可以在_post里使用markdown写你的文章。
### 预览网页
```
wooden prevew
```
这个命令会开启express来预览你的网站
### 编译网页
```
wooden build [dir] [--output target]
```
当你完成写作并使用以上命名，就可以来更新或者生成为html文件，现在把它放到你的静态服务器上去吧！
## 配置
其中，contact支持twitter,fb等其他社交信息
```
{
"name" : "hacke2's blog",
"contact" : {
"github" : "https://github.com/hacke2",
"Weibo" : "http://weibo.com/p/1005052330269092/",
"mail" : "[email protected]"
}
}
```
## 例子
当然，markdown非常简单，相信你已经会了，本系统也支持 `` 关键字，用来在首页显示摘要
```
---
title : hello, wooden
---
## abstract
>This is quote
article
```
## 下一步计划
* 加入评论系统能够
* 分页功能
# wooden
use markdown to build a static web page
```
npm install wooden -g
```
## step
### create empty project
```
wooden create [dir]
```
This command can create empty project, It contains four folders:
* `_post` your markdown file
* `_layout` layout file by jade
* `assets` static resources
you can user markdown to write your article in "_post" folders now。
### preview your web page
```
wooden prevew
```
It is Command will open web server by express.
### build
```
wooden build [dir] [--output target]
```
if you done your markdown, you make it to html.you can sent to your static server(e.g github page)
## config
contact can spport twitter,fb..
```
{
"name" : "hacke2's blog",
"contact" : {
"github" : "https://github.com/hacke2",
"Weibo" : "http://weibo.com/p/1005052330269092/",
"mail" : "[email protected]"
}
}
```
## example
I believe you learned how user markdown to write article, you can user `` for index page Where can show abstract.
```
---
title : hello, wooden
---
## abstract
>This is quote
article
```
## next
* comment system
* Paging