docsify/README.md

<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+
- Support SSR

## 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
Add logo (#28) * Fix table style * Add logo * Update index.html * Update doc 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">`
fix some links 2017-03-16 05:32:33 +08:00			`<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>`
Update badges 2016-12-18 19:43:58 +08:00			`<a href="https://www.npmjs.com/package/docsify"><img alt="npm" src="https://img.shields.io/npm/v/docsify.svg?style=flat-square"></a>`
docs(readme): add donate 2017-02-12 16:30:45 +08:00			`<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>`
Add logo (#28) * Fix table style * Add logo * Update index.html * Update doc 2016-12-18 15:30:50 +08:00			`</p>`
first commit 2016-11-20 15:56:37 +08:00
Add buble 2016-11-26 18:08:00 +08:00			`## Links`
update main markdown files 2017-03-10 05:19:57 +08:00
fix url 2016-11-28 15:39:35 +08:00			`- [Documentation](https://docsify.js.org)`
Add buble 2016-11-26 18:08:00 +08:00			`- [CLI](https://github.com/QingWei-Li/docsify-cli)`
Remove plugins 2016-11-26 14:09:06 +08:00
first commit 2016-11-20 15:56:37 +08:00			`## Features`
Update docs: Getting started (#85) * fixed look of links in blockquote * updated main README * updated getting started * updated more-pages * make custom sidebar loading clear * updated custom navbar * added markdown comments * updated cover documentation * updated cover page * updated sidebar 2017-02-21 14:04:16 +08:00
			`- No statically built html files`
fix(search): dont search nameLink, fixed #102 2017-02-24 20:15:15 +08:00			`- Simple and lightweight (~16kB gzipped)`
docs(en) finish 2017-02-13 22:43:58 +08:00			`- Smart full-text search plugin`
Update features 2016-12-20 22:32:56 +08:00			`- Multiple themes`
docs(en) finish 2017-02-13 22:43:58 +08:00			`- Useful plugin API`
refactor(core): add render 2017-02-17 23:09:09 +08:00			`- Compatible with IE10+`
update readme 2017-05-30 14:01:06 +08:00			`- Support SSR`
first commit 2016-11-20 15:56:37 +08:00
			`## Quick start`
update main markdown files 2017-03-10 05:19:57 +08:00
			Create an `index.html`.
first commit 2016-11-20 15:56:37 +08:00
			```html
Update docs: Getting started (#85) * fixed look of links in blockquote * updated main README * updated getting started * updated more-pages * make custom sidebar loading clear * updated custom navbar * added markdown comments * updated cover documentation * updated cover page * updated sidebar 2017-02-21 14:04:16 +08:00			`<!-- index.html -->`

first commit 2016-11-20 15:56:37 +08:00			`<!DOCTYPE html>`
			`<html>`
			`<head>`
			`<meta charset="UTF-8">`
fix some links 2017-03-16 05:32:33 +08:00			`<link rel="stylesheet" href="//unpkg.com/docsify/lib/themes/vue.css">`
first commit 2016-11-20 15:56:37 +08:00			`</head>`
Update readme 2016-12-17 15:25:03 +08:00			`<body>`
			`<div id="app"></div>`
			`</body>`
fix some links 2017-03-16 05:32:33 +08:00			`<script src="//unpkg.com/docsify/lib/docsify.min.js"></script>`
first commit 2016-11-20 15:56:37 +08:00			`</html>`
			```

clean api 2017-02-05 09:50:08 +08:00			`## Browser Support`

Update docs: Getting started (#85) * fixed look of links in blockquote * updated main README * updated getting started * updated more-pages * make custom sidebar loading clear * updated custom navbar * added markdown comments * updated cover documentation * updated cover page * updated sidebar 2017-02-21 14:04:16 +08:00			`Modern browsers and Internet Explorer 10+.`
clean api 2017-02-05 09:50:08 +08:00
add showcase 2016-11-28 14:03:54 +08:00			`## Showcase`
update main markdown files 2017-03-10 05:19:57 +08:00
Update docs: Getting started (#85) * fixed look of links in blockquote * updated main README * updated getting started * updated more-pages * make custom sidebar loading clear * updated custom navbar * added markdown comments * updated cover documentation * updated cover page * updated sidebar 2017-02-21 14:04:16 +08:00			`These open-source projects are using docsify to generate their sites. Pull requests welcome :blush:`
add showcase 2016-11-28 14:03:54 +08:00
update main markdown files 2017-03-10 05:19:57 +08:00			`\| 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 \|`
Add JS MythBusters to showcase (#148) 2017-04-17 20:32:38 +08:00			`\| [JS MythBusters](https://mythbusters.js.org) \| An optimization handbook from a high level point of view. \|`
Add hire-me to showcase section 2017-04-21 06:02:39 +08:00			`\| [hire-me](https://fvcproductions.github.io/hire-me) \| A path to getting an awesome tech gig. \|`
Add vue-amap into README.md (#161) * Update README.md * Update README.md 2017-05-25 11:57:37 +08:00			`\| [vue-amap](https://elemefe.github.io/vue-amap/) \| A Map Component Library Base on Vue 2.x and Gaode Map. \|`
add showcase 2016-11-28 14:03:54 +08:00
Add similar projects into readme 2016-12-23 09:25:30 +08:00			`## Similar projects`
update main markdown files 2017-03-10 05:19:57 +08:00
			`\| Project \| Description \|`
			`\|---\|---\|`
			`\| [docute](https://github.com/egoist/docute) \| 📜 Effortlessly documentation done right \|`
			`\| [docpress](https://github.com/docpress/docpress) \| Documentation website generator \|`
Add similar projects into readme 2016-12-23 09:25:30 +08:00
Update features 2016-12-20 22:32:56 +08:00			`## Contributing`
Add dev script 2016-11-26 18:37:17 +08:00
Add Snipaste into showcase 2016-12-01 10:18:00 +08:00			`- Fork it!`
Update readme 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`
Update docs: Getting started (#85) * fixed look of links in blockquote * updated main README * updated getting started * updated more-pages * make custom sidebar loading clear * updated custom navbar * added markdown comments * updated cover documentation * updated cover page * updated sidebar 2017-02-21 14:04:16 +08:00			`- Submit a pull request`
Update features 2016-12-20 22:32:56 +08:00

			`## Development`

Add bash/markdown highlight 2017-01-10 23:55:58 +08:00			```bash
Update features 2016-12-20 22:32:56 +08:00			`npm i && npm run dev`
			`open http://localhost:3000`
			```
Add dev script 2016-11-26 18:37:17 +08:00
first commit 2016-11-20 15:56:37 +08:00			`## License`
update main markdown files 2017-03-10 05:19:57 +08:00
first commit 2016-11-20 15:56:37 +08:00			`MIT`