archive-gh-me/docsify
1
0
Fork 0
mirror of https://github.com/docsifyjs/docsify.git synced 2025-12-08 19:55:52 +00:00
Code Issues Projects Releases Wiki Activity
docsify/docs/cover.md
Jintzo feb4b89461 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

1.1 KiB
Raw Blame History

Cover

Activate the cover feature by setting coverpage to true. Details are available in the coverpage configuration paragraph.

Basic usage

Set coverpage to true, and create a _coverpage.md:

<!-- index.html -->

<script>
  window.$docsify = {
    coverpage: true
  }
</script>
<script src="//unpkg.com/docsify"></script>

<!-- _coverpage.md -->

![logo](_media/icon.svg)

# docsify <small>3.0</small>

> A magical documentation site generator.

- Simple and lightweight (~14kB gzipped)
- No statically built html files
- Multiple themes


[GitHub](https://github.com/QingWei-Li/docsify/)
[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 -->

# docsify

[GitHub](https://github.com/QingWei-Li/docsify/)
[Get Started](#quick-start)

<!-- background image -->
![](_media/bg.png)
<!-- background color -->
![color](#f0f0f0)