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

Update docs: Getting started (#85)

Browse source 
* 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
This commit is contained in:
Jintzo 2017-02-21 07:04:16 +01:00 • committed by cinwell.li
commit feb4b89461
8 changed files with 76 additions and 64 deletions
Download patch file Download diff file Expand all files Collapse all files

13
README.md
View file

@ -19,7 +19,8 @@
- [CLI](https://github.com/QingWei-Li/docsify-cli)
## Features
- Not build static html files
- No statically built html files
- Simple and lightweight (~14kB gzipped)
- Smart full-text search plugin
- Multiple themes
@ -29,9 +30,9 @@
## Quick start
Create a `index.html`.
index.html
```html
<!-- index.html -->
<!DOCTYPE html>
<html>
<head>
@ -47,10 +48,10 @@ index.html
## Browser Support
Modern browsers and Internet Explorer 9+.
Modern browsers and Internet Explorer 10+.
## Showcase
These open-source projects are using docsify to generate their sites. Pull requests welcome : )
These open-source projects are using docsify to generate their sites. Pull requests welcome :blush:
- [Snipaste](https://docs.snipaste.com/) - Snip & Paste
- [puck](https://puck.zz173.com/) - A small & magical php framework.
@ -69,7 +70,7 @@ These open-source projects are using docsify to generate their sites. Pull reque
- 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 :D
- Submit a pull request
## Development