mirror of
https://github.com/docsifyjs/docsify.git
synced 2025-12-08 19:55:52 +00:00
101 lines
1.8 KiB
Markdown
101 lines
1.8 KiB
Markdown
# Cover
|
|
|
|
Activate the cover feature by setting `coverpage` to **true**. See [coverpage configuration](configuration#coverpage).
|
|
|
|
## Basic usage
|
|
|
|
Set `coverpage` to **true**, and create a `_coverpage.md`:
|
|
|
|
```js
|
|
window.$docsify = {
|
|
coverpage: true,
|
|
};
|
|
```
|
|
|
|
```markdown
|
|
<!-- _coverpage.md -->
|
|
|
|
|
|
|
|
# docsify
|
|
|
|
> A magical documentation site generator
|
|
|
|
- Simple and lightweight
|
|
- No statically built HTML files
|
|
- Multiple themes
|
|
|
|
[GitHub](https://github.com/docsifyjs/docsify/)
|
|
[Get Started](#docsify)
|
|
```
|
|
|
|
## Customization
|
|
|
|
The cover page can be customized using [theme properties](themes#theme-properties):
|
|
|
|
<!-- prettier-ignore -->
|
|
```css
|
|
:root {
|
|
--cover-bg : url('path/to/image.png');
|
|
--cover-bg-overlay : rgba(0, 0, 0, 0.5);
|
|
--cover-color : #fff;
|
|
--cover-title-color: var(--theme-color);
|
|
--cover-title-font : 600 var(--font-size-xxxl) var(--font-family);
|
|
}
|
|
```
|
|
|
|
Alternatively, a background color or image can be specified in the cover page markdown.
|
|
|
|
```markdown
|
|
<!-- background color -->
|
|
|
|
|
|
```
|
|
|
|
```markdown
|
|
<!-- background image -->
|
|
|
|
|
|
```
|
|
|
|
## Coverpage as homepage
|
|
|
|
Normally, the coverpage and the homepage appear at the same time. Of course, you can also separate the coverpage by [`onlyCover`](configuration#onlycover) option.
|
|
|
|
## Multiple covers
|
|
|
|
If your docs site is in more than one language, it may be useful to set multiple covers.
|
|
|
|
For example, your docs structure is like this
|
|
|
|
```text
|
|
.
|
|
└── docs
|
|
├── README.md
|
|
├── guide.md
|
|
├── _coverpage.md
|
|
└── zh-cn
|
|
├── README.md
|
|
└── guide.md
|
|
└── _coverpage.md
|
|
```
|
|
|
|
Now, you can set
|
|
|
|
```js
|
|
window.$docsify = {
|
|
coverpage: ['/', '/zh-cn/'],
|
|
};
|
|
```
|
|
|
|
Or a special file name
|
|
|
|
```js
|
|
window.$docsify = {
|
|
coverpage: {
|
|
'/': 'cover.md',
|
|
'/zh-cn/': 'cover.md',
|
|
},
|
|
};
|
|
```
|