docsify/README.md
2016-11-28 15:39:35 +08:00

969 B

docsify

Build Status npm

🃏 A magical documentation site generator.

Features

  • Easy and lightweight
  • Custom themes
  • No build

Quick start

Create 404.html and README.md into /docs.

404.html

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

Showcase

These open-source projects are using docsify to generate their sites.

  • docsify - A magical documentation site generator.

How to contribute

  • Fork it and clone!
  • Run npm i && npm run dev

License

MIT