100 lines
1.9 KiB
Markdown
100 lines
1.9 KiB
Markdown
# 封面
|
|
|
|
通过设置 `coverpage` 参数，可以开启渲染封面的功能。具体用法见[配置项#coverpage](configuration.md#coverpage)。
|
|
|
|
## 基本用法
|
|
|
|
封面的生成同样是从 markdown 文件渲染来的。开启渲染封面功能后在文档根目录创建 `_coverpage.md` 文件。渲染效果如本文档。
|
|
|
|
_index.html_
|
|
|
|
```html
|
|
<script>
|
|
window.$docsify = {
|
|
coverpage: true
|
|
}
|
|
</script>
|
|
<script src="//unpkg.com/docsify"></script>
|
|
```
|
|
|
|
_\_coverpage.md_
|
|
|
|
```markdown
|
|
|
|
|
|
# docsify
|
|
|
|
> A magical documentation site generator.
|
|
|
|
* Simple and lightweight (~12kb gzipped)
|
|
* Multiple themes
|
|
* Not build static html files
|
|
|
|
[GitHub](https://github.com/docsifyjs/docsify/)
|
|
[Get Started](#quick-start)
|
|
```
|
|
|
|
!> 一份文档只会在根目录下加载封面，其他页面或者二级目录下都不会加载。
|
|
|
|
## 自定义背景
|
|
|
|
目前的背景是随机生成的渐变色，我们自定义背景色或者背景图。在文档末尾用添加图片的 Markdown 语法设置背景。
|
|
|
|
_\_coverpage.md_
|
|
|
|
```markdown
|
|
# docsify
|
|
|
|
[GitHub](https://github.com/docsifyjs/docsify/)
|
|
[Get Started](#quick-start)
|
|
|
|
<!-- 背景图片 -->
|
|
|
|
|
|
|
|
<!-- 背景色 -->
|
|
|
|
|
|
```
|
|
|
|
## 封面作为首页
|
|
|
|
通常封面和首页是同时出现的，当然你也是当封面独立出来通过设置[onlyCover 选项](zh-cn/configuration.md#onlycover)。
|
|
|
|
## 多个封面
|
|
|
|
如果你的文档网站是多语言的，或许你需要设置多个封面。
|
|
|
|
例如你的文档目录结构如下
|
|
|
|
```text
|
|
.
|
|
└── docs
|
|
├── README.md
|
|
├── guide.md
|
|
├── _coverpage.md
|
|
└── zh-cn
|
|
├── README.md
|
|
└── guide.md
|
|
└── _coverpage.md
|
|
```
|
|
|
|
那么你可以这么配置
|
|
|
|
```js
|
|
window.$docsify = {
|
|
coverpage: ['/', '/zh-cn/']
|
|
};
|
|
```
|
|
|
|
或者具体指名文件名
|
|
|
|
```js
|
|
window.$docsify = {
|
|
coverpage: {
|
|
'/': 'cover.md',
|
|
'/zh-cn/': 'cover.md'
|
|
}
|
|
};
|
|
```
|