docsify

🃏 A magical documentation site generator.

Features

Easy and lightweight
Custom themes
No build

Quick start

Create a 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>

Or Create a index.html and using hash router.

index.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" data-router></script>
</html>

Showcase

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

docsify - A magical documentation site generator.
Snipaste - A new way to boost your productivity.

How to contribute

Fork it!
Run npm i && npm run dev
open localhost:3000

License

MIT

Support on Beerpay

Hey dude! Help me out for a couple of 🍻!

1.7 KiB Raw Blame History