mirror of
https://gitee.com/docsifyjs/docsify.git
synced 2024-12-02 20:20:30 +08:00
106 lines
3.9 KiB
Markdown
106 lines
3.9 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://cdnjs.com/libraries/docsify"><img alt="cdnjs" src="https://img.shields.io/cdnjs/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>
|
||
<a href="https://app.fossa.io/projects/git%2Bhttps%3A%2F%2Fgithub.com%2FQingWei-Li%2Fdocsify?ref=badge_shield" alt="FOSSA Status"><img src="https://app.fossa.io/api/projects/git%2Bhttps%3A%2F%2Fgithub.com%2FQingWei-Li%2Fdocsify.svg?type=shield"/></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 (~18kB gzipped)
|
||
- Smart full-text search plugin
|
||
- Multiple themes
|
||
- Useful plugin API
|
||
- Compatible with IE10+
|
||
- Support SSR ([example](https://github.com/QingWei-Li/docsify-ssr-demo))
|
||
|
||
## Quick start
|
||
|
||
Create an `index.html`.
|
||
|
||
```html
|
||
<!-- index.html -->
|
||
|
||
<!DOCTYPE html>
|
||
<html>
|
||
<head>
|
||
<meta charset="UTF-8">
|
||
<link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify/lib/themes/vue.css">
|
||
</head>
|
||
<body>
|
||
<div id="app"></div>
|
||
<script src="//cdn.jsdelivr.net/npm/docsify/lib/docsify.min.js"></script>
|
||
</body>
|
||
</html>
|
||
```
|
||
|
||
## Browser Support
|
||
|
||
Modern browsers and Internet Explorer 10+.
|
||
|
||
## Showcase
|
||
|
||
These 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. |
|
||
| [samlify](https://samlify.js.org) | Node.js SAML2 library |
|
||
| [palettify](https://dobromir-hristov.github.io/palettify/) | A color palette effects assistant |
|
||
| [commitlint](https://marionebl.github.io/commitlint/) | Lint commit messages |
|
||
| [vue-data-tables](https://github.com/njleonzhang/vue-data-tables/) | A simple and customizable data table，based on vue2 and element-ui. |
|
||
|
||
## 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 run bootstrap && npm run dev
|
||
open http://localhost:3000
|
||
```
|
||
|
||
## License
|
||
|
||
MIT
|
||
|
||
[](https://app.fossa.io/projects/git%2Bhttps%3A%2F%2Fgithub.com%2FQingWei-Li%2Fdocsify?ref=badge_large)
|