GitHub - zsae/docsify: 🃏 A magical documentation site generator.

Skip to content

Navigation Menu

Sign in

Appearance settings

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up

Appearance settings

Repository files navigation

docsify

Build Status npm

🃏 A magical documentation site generator.

Links

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>

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

About

🃏 A magical documentation site generator.

Resources

Readme

License

MIT license

Activity

Stars

0 stars

Watchers

0 watching

Forks

0 forks

Languages

  • JavaScript 84.0%
  • CSS 15.5%
  • HTML 0.5%