Interfacer ( ifer )
如何使用 Interfacer
一些特点:
features:
- 只支持 Markdown
- 目录结构即是文档结构
- 命令行
- 热重载 Livereload
- Only Markdown For Writing
- doc directory structrue
map to
doc struture - CLI
- LiverReload
- the depth of directory is depth of your doc title level
- There is ONLY file in each doc directory, His Name is
index.md
- BWY,each index.md in directory will be transformed to
index.html
as the entry of the doc
- 目录深度即是标题级数
- 每一个 doc 文件夹有且仅有一个文件 叫做
index.md
- 额。。每一个
index.md
最后会被转化成index.html
作为文档入口
$ npm install -g interfacer
ifer 的启动需要配置文件的驱动:
Run ifer with config file:
module.exports = {
BASE: __dirname,
// Absolute Location
docRoot: 'PATH/TO/YOUR/DOCROOT',
// Absolute Location
output: 'PATH/TO/OUTPUT',
PORT: 3322,
// 主页的显示文字
welcome: '欢迎来到',
// 主页的title标签
mainTitle: 'Interfacer 使用手册'
}
just run this:
$ ifer -c <YourConfig_File>
and then ifer will listen 3322
( PORT in your config.js )
跑了上面的代码,然后就可以启动了 (3322)。