2017-02-13 22:43:58 +08:00
|
|
|
# Cover
|
|
|
|
|
2017-03-25 15:52:21 +08:00
|
|
|
Activate the cover feature by setting `coverpage` to **true**, compare [coverpage configuration](configuration.md#coverpage).
|
2017-02-13 22:43:58 +08:00
|
|
|
|
|
|
|
## Basic usage
|
|
|
|
|
2017-02-21 14:04:16 +08:00
|
|
|
Set `coverpage` to **true**, and create a `_coverpage.md`:
|
2017-02-13 22:43:58 +08:00
|
|
|
|
|
|
|
```html
|
2017-02-21 14:04:16 +08:00
|
|
|
<!-- index.html -->
|
|
|
|
|
2017-02-13 22:43:58 +08:00
|
|
|
<script>
|
|
|
|
window.$docsify = {
|
|
|
|
coverpage: true
|
|
|
|
}
|
|
|
|
</script>
|
2017-03-10 05:19:07 +08:00
|
|
|
<script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
|
2017-02-13 22:43:58 +08:00
|
|
|
```
|
|
|
|
|
|
|
|
```markdown
|
2017-02-21 14:04:16 +08:00
|
|
|
<!-- _coverpage.md -->
|
|
|
|
|
2017-02-13 22:43:58 +08:00
|
|
|
![logo](_media/icon.svg)
|
|
|
|
|
2017-03-10 05:19:07 +08:00
|
|
|
# docsify <small>3.5</small>
|
2017-02-13 22:43:58 +08:00
|
|
|
|
|
|
|
> A magical documentation site generator.
|
|
|
|
|
2017-06-02 22:37:27 +08:00
|
|
|
- Simple and lightweight (~18kB gzipped)
|
2017-02-21 14:04:16 +08:00
|
|
|
- No statically built html files
|
2017-02-13 22:43:58 +08:00
|
|
|
- Multiple themes
|
|
|
|
|
|
|
|
[GitHub](https://github.com/QingWei-Li/docsify/)
|
2017-02-21 14:04:16 +08:00
|
|
|
[Get Started](#docsify)
|
2017-02-13 22:43:58 +08:00
|
|
|
```
|
|
|
|
|
2017-03-10 05:19:07 +08:00
|
|
|
!> A document site can have only one coverpage!
|
2017-02-13 22:43:58 +08:00
|
|
|
|
|
|
|
## Custom background
|
|
|
|
|
2017-03-10 05:19:07 +08:00
|
|
|
The background color is generated randomly by default. You can customize the background color or a background image:
|
2017-02-13 22:43:58 +08:00
|
|
|
|
|
|
|
```markdown
|
2017-02-21 14:04:16 +08:00
|
|
|
<!-- _coverpage.md -->
|
|
|
|
|
2017-03-10 05:19:07 +08:00
|
|
|
# docsify <small>3.5</small>
|
2017-02-13 22:43:58 +08:00
|
|
|
|
|
|
|
[GitHub](https://github.com/QingWei-Li/docsify/)
|
|
|
|
[Get Started](#quick-start)
|
|
|
|
|
|
|
|
<!-- background image -->
|
|
|
|
![](_media/bg.png)
|
2017-03-10 05:19:07 +08:00
|
|
|
|
2017-02-13 22:43:58 +08:00
|
|
|
<!-- background color -->
|
|
|
|
![color](#f0f0f0)
|
|
|
|
```
|