2016-12-18 15:30:50 +08:00
|
|
|
<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">
|
2016-12-18 19:43:58 +08:00
|
|
|
<a href="https://travis-ci.org/QingWei-Li/docsify"><img alt="Travis Status" src="https://img.shields.io/travis/rust-lang/rust/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>
|
2016-12-20 22:19:12 +08:00
|
|
|
<a href="https://github.com/vuejs/vue"><img alt="code style" src="https://img.shields.io/badge/code%20style-vue-orange.svg?style=flat-square"></a>
|
2016-12-18 15:30:50 +08:00
|
|
|
</p>
|
2016-11-20 15:56:37 +08:00
|
|
|
|
2016-11-26 18:08:00 +08:00
|
|
|
## Links
|
2016-11-28 15:39:35 +08:00
|
|
|
- [Documentation](https://docsify.js.org)
|
2016-11-26 18:08:00 +08:00
|
|
|
- [CLI](https://github.com/QingWei-Li/docsify-cli)
|
2016-11-26 14:09:06 +08:00
|
|
|
|
2016-11-20 15:56:37 +08:00
|
|
|
## Features
|
2017-01-04 21:49:16 +08:00
|
|
|
- Simple and lightweight (~13kB gzipped)
|
2016-12-20 22:32:56 +08:00
|
|
|
- Multiple themes
|
|
|
|
|
- Not build static html files
|
2016-11-20 15:56:37 +08:00
|
|
|
|
|
|
|
|
## Quick start
|
2016-12-20 22:32:56 +08:00
|
|
|
Create a `index.html` and using `hash router`.
|
2016-11-20 15:56:37 +08:00
|
|
|
|
2016-12-20 22:32:56 +08:00
|
|
|
index.html
|
2016-11-20 15:56:37 +08:00
|
|
|
|
|
|
|
|
```html
|
|
|
|
|
<!DOCTYPE html>
|
|
|
|
|
<html>
|
|
|
|
|
<head>
|
|
|
|
|
<meta charset="UTF-8">
|
2016-11-20 22:49:32 +08:00
|
|
|
<link rel="stylesheet" href="//unpkg.com/docsify/themes/vue.css">
|
2016-11-20 15:56:37 +08:00
|
|
|
</head>
|
2016-12-17 15:25:03 +08:00
|
|
|
<body>
|
|
|
|
|
<div id="app"></div>
|
|
|
|
|
</body>
|
2016-12-20 22:32:56 +08:00
|
|
|
<script src="//unpkg.com/docsify" data-router></script>
|
2016-11-20 15:56:37 +08:00
|
|
|
</html>
|
|
|
|
|
```
|
|
|
|
|
|
2016-12-20 10:20:56 +08:00
|
|
|
## CDN
|
|
|
|
|
- UNPKG [https://unpkg.com/docsify/](https://unpkg.com/docsify/)
|
|
|
|
|
- jsDelivr [http://www.jsdelivr.com/projects/docsify](http://www.jsdelivr.com/projects/docsify)
|
|
|
|
|
|
2016-11-28 14:03:54 +08:00
|
|
|
## Showcase
|
2016-12-01 10:18:00 +08:00
|
|
|
These open-source projects are using docsify to generate their sites. Pull requests welcome : )
|
2016-11-28 14:03:54 +08:00
|
|
|
|
|
|
|
|
- [docsify](https://docsify.js.org) - A magical documentation site generator.
|
2016-12-01 10:18:00 +08:00
|
|
|
- [Snipaste](https://docs.snipaste.com/) - A new way to boost your productivity.
|
2017-01-02 07:31:03 +08:00
|
|
|
- [puck](https://puck.zz173.com/) - A small & magical php framework.
|
2016-11-28 14:03:54 +08:00
|
|
|
|
2016-12-23 09:25:30 +08:00
|
|
|
## Similar projects
|
|
|
|
|
- [docute](https://github.com/egoist/docute) - 📜 Effortlessly documentation done right
|
|
|
|
|
- [docpress](https://github.com/docpress/docpress) - Documentation website generator
|
|
|
|
|
|
2016-12-20 22:32:56 +08:00
|
|
|
## Contributing
|
2016-11-26 18:37:17 +08:00
|
|
|
|
2016-12-01 10:18:00 +08:00
|
|
|
- Fork it!
|
2016-12-20 22:34:13 +08:00
|
|
|
- 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`
|
2016-12-20 22:32:56 +08:00
|
|
|
- Submit a pull request :D
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Development
|
|
|
|
|
|
2017-01-02 07:31:03 +08:00
|
|
|
### prepare
|
2016-12-20 22:32:56 +08:00
|
|
|
```shell
|
|
|
|
|
npm i && npm run dev
|
|
|
|
|
open http://localhost:3000
|
|
|
|
|
```
|
2016-11-26 18:37:17 +08:00
|
|
|
|
2017-01-03 15:48:57 +08:00
|
|
|
### More Language Highlight
|
2017-01-02 07:31:03 +08:00
|
|
|
|
2017-01-03 15:48:57 +08:00
|
|
|
```html
|
|
|
|
|
<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>
|
|
|
|
|
```
|
2017-01-02 07:31:03 +08:00
|
|
|
|
2016-11-20 15:56:37 +08:00
|
|
|
## License
|
|
|
|
|
MIT
|
2016-12-15 19:11:15 +08:00
|
|
|
|
