Giter VIP home page Giter VIP logo

mdjs's Introduction

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

mdjs's People

Contributors

xuexb avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.