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
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

View file

@ -1,15 +1,14 @@
# Cover
Activate the cover feature by setting `coverpage`. The detail in [Configuration#coverpage](configuration#coverpage).
Activate the cover feature by setting `coverpage` to **true**. Details are available in the [coverpage configuration paragraph](configuration#coverpage).
## Basic usage
Set `coverpage` to **true**, and create a `_coverpage.md`. You can see the effect in current website.
*index.html*
Set `coverpage` to **true**, and create a `_coverpage.md`:
```html
<!-- index.html -->
<script>
window.$docsify = {
coverpage: true
@ -18,33 +17,34 @@ Set `coverpage` to **true**, and create a `_coverpage.md`. You can see the effec
<script src="//unpkg.com/docsify"></script>
```
*_coverpage.md*
```markdown
<!-- _coverpage.md -->
![logo](_media/icon.svg)
# docsify
# docsify <small>3.0</small>
> A magical documentation site generator.
- Simple and lightweight (~12kb gzipped)
- Simple and lightweight (~14kB gzipped)
- No statically built html files
- Multiple themes
- Not build static html files
[GitHub](https://github.com/QingWei-Li/docsify/)
[Get Started](#quick-start)
[Get Started](#docsify)
```
!> A document site can have only one cover page.
## Custom background
The background color is generated randomly by default. You can customize the background color or image.
*_coverpage.md*
The background color is generated randomly by default. You can customize the background color or image:
```markdown
<!-- _coverpage.md -->
# docsify
[GitHub](https://github.com/QingWei-Li/docsify/)