mirror of
https://gitee.com/docsifyjs/docsify.git
synced 2024-12-01 03:30:00 +08:00
97 lines
2.8 KiB
Markdown
97 lines
2.8 KiB
Markdown
<p align="center">
|
|
<a href="https://docsify.js.org">
|
|
<img alt="docsify" src="./media/docsify.png">
|
|
</a>
|
|
</p>
|
|
|
|
<p align="center">
|
|
A magical documentation site generator.
|
|
</p>
|
|
|
|
<p align="center">
|
|
<a href="https://travis-ci.org/QingWei-Li/docsify"><img alt="Travis Status" src="https://img.shields.io/travis/QingWei-Li/docsify/master.svg?style=flat-square"></a>
|
|
<a href="https://www.npmjs.com/package/docsify"><img alt="npm" src="https://img.shields.io/npm/v/docsify.svg?style=flat-square"></a>
|
|
<a href="https://github.com/QingWei-Li/donate"><img alt="donate" src="https://img.shields.io/badge/%24-donate-ff69b4.svg?style=flat-square"></a>
|
|
</p>
|
|
|
|
## Links
|
|
|
|
- [Documentation](https://docsify.js.org)
|
|
- [CLI](https://github.com/QingWei-Li/docsify-cli)
|
|
|
|
## 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`.
|
|
|
|
```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 :blush:
|
|
|
|
| Project | Description |
|
|
|---|---|
|
|
| [Snipaste](https://docs.snipaste.com/) | Snip & Paste |
|
|
| [puck](https://puck.zz173.com/) | A small & magical php framework. |
|
|
| [Samaritan](http://samaritan.stockdb.org) | An Algorithmic Trading Framework for Digital Currency. |
|
|
| [Vudash](http://vudash.github.io/vudash/) | Powerful, Flexible, Open Source dashboards for anything |
|
|
| [Trilogy](http://trilogy.js.org) | No-hassle SQLite with a Promise-based, document store style API. |
|
|
| [Mybatis-Plus](http://mp.baomidou.com/) | An enhanced toolkit of Mybatis to simplify development |
|
|
| [JS MythBusters](https://mythbusters.js.org) | An optimization handbook from a high level point of view. |
|
|
| [hire-me](https://fvcproductions.github.io/hire-me) | A path to getting an awesome tech gig. |
|
|
| [vue-amap](https://elemefe.github.io/vue-amap/) | A Map Component Library Base on Vue 2.x and Gaode Map. |
|
|
|
|
## Similar projects
|
|
|
|
| Project | Description |
|
|
|---|---|
|
|
| [docute](https://github.com/egoist/docute) | 📜 Effortlessly documentation done right |
|
|
| [docpress](https://github.com/docpress/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
|
|
|
|
```bash
|
|
npm i && npm run dev
|
|
open http://localhost:3000
|
|
```
|
|
|
|
## License
|
|
|
|
MIT
|