JSPM – docsify@1.5.0

Package Exports

docsify

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (docsify) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

A magical documentation site generator.

Features

Simple and lightweight (~13kB gzipped)
Multiple themes
Not build static html files

Quick start

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>
  <div id="app"></div>
</body>
<script src="//unpkg.com/docsify" data-router></script>
</html>

CDN

UNPKG https://unpkg.com/docsify/
jsDelivr http://www.jsdelivr.com/projects/docsify

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.
puck - A small & magical php framework.

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 :D

Development

prepare

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

More Language Highlight

<script src="//unpkg.com/docsify"></script>
<script src="//unpkg.com/prismjs/components/prism-bash.js"></script>
<script src="//unpkg.com/prismjs/components/prism-php.js"></script>

License

MIT

docsify