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.
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 😊
| 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 | 📜 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
Development
npm i && npm run dev
open http://localhost:3000License
MIT