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

Skip to content

Commit adead4c

Browse files
Update README.md
1 parent 778f1b2 commit adead4c

File tree

1 file changed

+30
-16
lines changed

1 file changed

+30
-16
lines changed

docs/README.md

Lines changed: 30 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -276,37 +276,51 @@ This is really the text of heading element, which has been made lowercase and hy
276276

277277
### 5. Configure cover page
278278

279-
The cover page is the first page that a visitor sees before scrolling down to the homepage.
279+
Docsify provides a cover page - a simple page that a visitor sees before scrolling down to the homepage which has centered text, a background and a summary of your application.
280280

281-
If you want to use it, edit your *docs/_coverpage.md* file and complete the `TODO` items. You can also use this project's [cover page](https://raw.githubusercontent.com/MichaelCurrin/docsify-js-tutorial/master/docs/_coverpage.md) on Github as a reference.
281+
If you want to use it, make sure `coverpage: true` is set in your app config.
282282

283-
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.
283+
Then create and edit a *docs/_coverpage.md* file. You can also use the template project's [cover page](https://raw.githubusercontent.com/MichaelCurrin/docsify-js-template/master/docs/_coverpage.md) on Github as a reference.
284284

285-
The _Docsify_ site explains how to set a background image or color [here](https://docsify.js.org/#/cover?id=custom-background).
285+
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.
286286

287-
Example:
288-
289-
```markdown
290-
<!-- background image -->
287+
You can delete the cover page and disable it in _index.html_.
291288

292-
![](_media/bg.png)
293-
```
289+
#### Cover background image
294290

295-
```markdown
296-
<!-- background color -->
291+
If you don't set a cover background, you'll get a different one on every refresh.
297292

298-
![color](#f0f0f0)
299-
```
293+
The _Docsify_ site explains how to set a background image or color [here](https://docsify.js.org/#/cover?id=custom-background).
300294

301295
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.
302296

303-
You can delete the cover page and disable it in _index.html_.
297+
Examples:
298+
299+
- Load an image file
300+
```markdown
301+
<!-- background image -->
304302

305-
#### Image
303+
![background image](_media/bg.png)
304+
```
305+
- Solid color
306+
```markdown
307+
<!-- background color -->
308+
309+
![color](#f0f0f0)
310+
```
311+
- Gradient color
312+
```markdown
313+
314+
![gradient](linear-gradient(to left bottom, hsl(202.6, 55.5%, 58.6%) 0%,hsl(0, 0%, 100%) 100%))
315+
```
316+
317+
#### Cover logo
306318

307319
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.
308320

309321
```markdown
322+
<!-- background image -->
323+
310324
![icon](_media/logo.svg)
311325
```
312326

0 commit comments

Comments
 (0)