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 an index.html.

<!-- index.html -->

<!DOCTYPE html>
<html>
<head>
  <meta charset="UTF-8">
  <link rel="stylesheet" href="//unpkg.com/docsify/lib/themes/vue.css">
</head>
<body>
  <div id="app"></div>
</body>
<script src="//unpkg.com/docsify/lib/docsify.min.js"></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:

Project Description
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
JS MythBusters An optimization handbook from a high level point of view.
hire-me A path to getting an awesome tech gig.

Similar projects

Project Description
docute

Related Repositories

fetool

fetool

大前端的瑞士军刀,只记录有用的 ...

mobx-zh-cn

mobx-zh-cn

Mobx Chinese-translations from https://mobx.js.org/ ordered by docsify ...


Top Contributors

QingWei-Li jrappen Leopoldthecoder bojand Jintzo liulex michellebrier onevcat gpresland nsina antony miaolz123 christopherwk210 yangyang0507 dobromir-hristov fvcproductions kevinresol Kikobeats KimBurgess crawt njleonzhang reverland marionebl zckrs needim pra85 sufuf3 z-song tngan citycide

Releases

-   v4.2.6 zip tar
-   v4.2.4 zip tar
-   v4.2.3 zip tar
-   v4.2.2 zip tar
-   v4.2.1 zip tar
-   v4.2.0 zip tar
-   v4.1.14 zip tar
-   v4.1.13 zip tar
-   v4.1.12 zip tar
-   v4.1.11 zip tar
-   v4.1.10 zip tar
-   v4.1.9 zip tar
-   v4.1.8 zip tar
-   v4.1.7 zip tar
-   v4.1.6 zip tar
-   v4.1.5 zip tar
-   v4.1.4 zip tar
-   v4.1.3 zip tar
-   v4.1.2 zip tar
-   v4.1.1 zip tar
-   v4.1.0 zip tar
-   v4.0.2 zip tar
-   v4.0.1 zip tar
-   v4.0.0 zip tar
-   v3.7.3 zip tar
-   v3.7.2 zip tar
-   v3.7.1 zip tar
-   v3.7.0 zip tar
-   v3.6.6 zip tar
-   v3.6.5 zip tar