docsify

一个基于 Vue 的神奇的文档站点生成器

docsify

A magical documentation site generator.

Travis Status npm donate

Links

Features

  • No statically built html files
  • Simple and lightweight (~16kB gzipped)
  • Smart full-text search plugin
  • Multiple themes
  • Useful plugin API
  • Compatible with IE10+

Quick start

Create a index.html.

<!-- index.html -->

<!DOCTYPE html>
<html>
<head>
  <meta charset="UTF-8">
  <link rel="stylesheet" href="//unpkg.com/docsify/themes/vue.css">
</head>
<body>
  <div id="app"></div>
</body>
<script src="//unpkg.com/docsify"></script>
</html>

Browser Support

Modern browsers and Internet Explorer 10+.

Showcase

These open-source projects are using docsify to generate their sites. Pull requests welcome :blush:

  • Snipaste - Snip & Paste
  • puck - A small & magical php framework.
  • Samaritan - An Algorithmic Trading Framework for Digital Currency.
  • Vudash - Powerful, Flexible, Open Source dashboards for anything
  • Trilogy - No-hassle SQLite with a Promise-based, document store style API.
  • Mybatis-Plus - An enhanced toolkit of Mybatis to simplify development

Similar projects

  • docute - ? Effortlessly documentation done right
  • docpress - Documentation website generator

Contributing

  • Fork it!
  • Create your feature branch: git checkout -b my-new-feature
  • Commit your changes: git commit -am 'Add some feature'
  • Push to the branch: git push origin my-new-feature
  • Submit a pull request

Development

npm i && npm run dev
open http://localhost:3000

License

MIT

docsify 相关推荐
对于该库,你有要推荐的内容么?点此提交推荐
请文明评论,与人为善,比聪明更重要!
评论