docsify/docs/cover.md

58 lines
1.1 KiB
Markdown
Raw Normal View History

2017-02-13 22:43:58 +08:00
# Cover
Activate the cover feature by setting `coverpage` to **true**. Details are available in the [coverpage configuration paragraph](configuration#coverpage).
2017-02-13 22:43:58 +08:00
## Basic usage
Set `coverpage` to **true**, and create a `_coverpage.md`:
2017-02-13 22:43:58 +08:00
```html
<!-- index.html -->
2017-02-13 22:43:58 +08:00
<script>
window.$docsify = {
coverpage: true
}
</script>
<script src="//unpkg.com/docsify"></script>
```
```markdown
<!-- _coverpage.md -->
2017-02-13 22:43:58 +08:00
![logo](_media/icon.svg)
# docsify <small>3.0</small>
2017-02-13 22:43:58 +08:00
> A magical documentation site generator.
- Simple and lightweight (~14kB gzipped)
- No statically built html files
2017-02-13 22:43:58 +08:00
- Multiple themes
[GitHub](https://github.com/QingWei-Li/docsify/)
[Get Started](#docsify)
2017-02-13 22:43:58 +08:00
```
!> 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:
2017-02-13 22:43:58 +08:00
```markdown
<!-- _coverpage.md -->
2017-02-13 22:43:58 +08:00
# docsify
[GitHub](https://github.com/QingWei-Li/docsify/)
[Get Started](#quick-start)
<!-- background image -->
![](_media/bg.png)
<!-- background color -->
![color](#f0f0f0)
```