Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit a04a2ac

Browse files
feat: Add cover notes
1 parent 5ecc040 commit a04a2ac

File tree

1 file changed

+18
-2
lines changed

1 file changed

+18
-2
lines changed

docs/README.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -282,15 +282,31 @@ If you want to use it, edit your *docs/_coverpage.md* file and complete the `TOD
282282

283283
You can add additional buttons to the bottom of the homepage, but there should be no gaps between the lines in your file. And the last one will be solid while the others will be transparent.
284284

285-
The _Docsify_ site explains how to set a background image or color [here](https://docsify.js.org/#/cover?id=custom-background). A background image should come _after_ the buttons in your file, as _Docsify_ looks for an image there then uses CSS to place the image behind the content and give it faded grey look.
285+
The _Docsify_ site explains how to set a background image or color [here](https://docsify.js.org/#/cover?id=custom-background).
286+
287+
Example:
288+
289+
```markdown
290+
<!-- background image -->
291+
292+
![](_media/bg.png)
293+
```
294+
295+
```markdown
296+
<!-- background color -->
297+
298+
![color](#f0f0f0)
299+
```
300+
301+
A background image should come _after_ the buttons in your file, as _Docsify_ looks for an image there then uses CSS to place the image behind the content and give it faded grey look.
286302

287303
You can delete the cover page and disable it in _index.html_.
288304

289305
#### Image
290306

291307
You could include an image (logo, photo) above your project title. For example, you could do this if you have a file in a *docs/_media* directory.
292308

293-
```
309+
```markdown
294310
![icon](_media/logo.svg)
295311
```
296312

0 commit comments

Comments
 (0)