mirror of
https://gitee.com/docsifyjs/docsify.git
synced 2024-12-12 12:25:13 +08:00
1.1 KiB
1.1 KiB
Cover
Activate the cover feature by setting coverpage
to true, compare coverpage configuration.
Basic usage
Set coverpage
to true, and create a _coverpage.md
:
<!-- index.html -->
<script>
window.$docsify = {
coverpage: true
}
</script>
<script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
<!-- _coverpage.md -->
![logo](_media/icon.svg)
# docsify <small>3.5</small>
> A magical documentation site generator.
- Simple and lightweight (~16kB 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 coverpage!
Custom background
The background color is generated randomly by default. You can customize the background color or a background image:
<!-- _coverpage.md -->
# docsify <small>3.5</small>
[GitHub](https://github.com/QingWei-Li/docsify/)
[Get Started](#quick-start)
<!-- background image -->
![](_media/bg.png)
<!-- background color -->
![color](#f0f0f0)