Skip to content
master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
src
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

mdjs

一个纯洁的md文档在线浏览,md是指markdown

在线文档


NPM Version Linux Build Windows Build Test Coverage star Follow

功能

  • 目录导航自动抓取(递归抓取options.root目录下包含.md文件的非空目录)
  • md文件的导航文件名使用文件内第1个标题
  • 导航里目录支持别名options.dir_alias
  • 导航里追加自定义的链接options.links
  • 自定义勾子express.get
  • 自制主题(其实感觉也没必要)
  • 搜索

安装

nodejs 0.12+

npm install mdjs --save

启动

var Mdjs = require('mdjs');

var app = new Mdjs(options).run();

options配置点这里:配置

作者

前端小武

感谢

mdjs默认的样式使用 pjax阮老师的es6样式

License

MIT

Changelog

changelog