jyapayne/docsify
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update features

Browse source
This commit is contained in:
qingwei.li 2016-12-20 22:32:56 +08:00
commit 3b02b8fc39
2 changed files with 26 additions and 28 deletions
Download patch file Download diff file Expand all files Collapse all files

48
README.md
View file

@ -19,30 +19,12 @@
- [CLI](https://github.com/QingWei-Li/docsify-cli) - [CLI](https://github.com/QingWei-Li/docsify-cli)
## Features ## Features
- Easy and lightweight (~12kb gzipped) - Simple and lightweight (~12kb gzipped)
- Custom themes - Multiple themes
- No build - Not build static html files
## Quick start ## Quick start
Create a `404.html` and `README.md` into `/docs`. Create a `index.html` and using `hash router`.
404.html
```html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<link rel="stylesheet" href="//unpkg.com/docsify/themes/vue.css">
</head>
<body>
<div id="app"></div>
</body>
<script src="//unpkg.com/docsify"></script>
</html>
```
Or Create a `index.html` and using `hash router`.
index.html index.html
@ -60,6 +42,12 @@ index.html
</html> </html>
``` ```
Or create a `404.html` and `README.md` into `/docs`. Just remove `data-router`
```html
<script src="//unpkg.com/docsify"></script>
```
## CDN ## CDN
- UNPKG [https://unpkg.com/docsify/](https://unpkg.com/docsify/) - UNPKG [https://unpkg.com/docsify/](https://unpkg.com/docsify/)
- jsDelivr [http://www.jsdelivr.com/projects/docsify](http://www.jsdelivr.com/projects/docsify) - jsDelivr [http://www.jsdelivr.com/projects/docsify](http://www.jsdelivr.com/projects/docsify)
@ -70,11 +58,21 @@ These open-source projects are using docsify to generate their sites. Pull reque
- [docsify](https://docsify.js.org) - A magical documentation site generator. - [docsify](https://docsify.js.org) - A magical documentation site generator.
- [Snipaste](https://docs.snipaste.com/) - A new way to boost your productivity. - [Snipaste](https://docs.snipaste.com/) - A new way to boost your productivity.
## How to contribute ## Contributing
- Fork it! - Fork it!
- Run `npm i && npm run dev` - Create your feature branch: git checkout -b my-new-feature
- open `localhost:3000` - Commit your changes: git commit -am 'Add some feature'
- Push to the branch: git push origin my-new-feature
- Submit a pull request :D
## Development
```shell
npm i && npm run dev
open http://localhost:3000
```
## License ## License
MIT MIT

6
docs/README.md
View file

@ -7,9 +7,9 @@
</p> </p>
## Features ## Features
- Easy and lightweight (~12kb gzipped) - Simple and lightweight (~12kb gzipped)
- Custom themes - Multiple themes
- No build - Not build static html files
## Quick Start ## Quick Start