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

8
docs/README.md
View file

@ -4,13 +4,13 @@
## What is it
docsify generates your documentation website on the fly. Unlike GitBook, it does not generate static html files. It smartly loads and parses your Markdown files and displays them in website. All you need to do is create an `index.html` to start and [deploy it on GitHub Pages](/deploy).
docsify generates your documentation website on the fly. Unlike GitBook, it does not generate static html files. Instead, it smartly loads and parses your Markdown files and displays them as website. All you need to do is create an `index.html` to start and [deploy it on GitHub Pages](/deploy).
See the [Quick start](/quickstart) for more details.
## Features
- Not build static html files
- No statically built html files
- Simple and lightweight (~14kB gzipped)
- Smart full-text search plugin
- Multiple themes
@ -19,9 +19,9 @@ See the [Quick start](/quickstart) for more details.
## Examples
Check out the [Showcase](https://github.com/QingWei-Li/docsify/#showcase) to see use the docsify generated website.
Check out the [Showcase](https://github.com/QingWei-Li/docsify/#showcase) to docsify in use.
## Donate
If you think docsify is helpful to you or that my work is valuable. I am happy if you can help me [buy a cup of coffee](https://github.com/QingWei-Li/donate). :heart:
Please consider donating if you think docsify is helpful to you or that my work is valuable. I am happy if you can help me [buy a cup of coffee](https://github.com/QingWei-Li/donate). :heart: