You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/README.md
+30-16Lines changed: 30 additions & 16 deletions
Original file line number
Diff line number
Diff line change
@@ -276,37 +276,51 @@ This is really the text of heading element, which has been made lowercase and hy
276
276
277
277
### 5. Configure cover page
278
278
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.
280
280
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.
282
282
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.
284
284
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.
286
286
287
-
Example:
288
-
289
-
```markdown
290
-
<!-- background image -->
287
+
You can delete the cover page and disable it in _index.html_.
291
288
292
-

293
-
```
289
+
#### Cover background image
294
290
295
-
```markdown
296
-
<!-- background color -->
291
+
If you don't set a cover background, you'll get a different one on every refresh.
297
292
298
-

299
-
```
293
+
The _Docsify_ site explains how to set a background image or color [here](https://docsify.js.org/#/cover?id=custom-background).
300
294
301
295
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.
302
296
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 -->
304
302
305
-
#### Image
303
+

304
+
```
305
+
- Solid color
306
+
```markdown
307
+
<!-- background color -->
308
+
309
+

310
+
```
311
+
- Gradient color
312
+
```markdown
313
+
314
+
 0%,hsl(0, 0%, 100%) 100%))
315
+
```
316
+
317
+
#### Cover logo
306
318
307
319
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.
0 commit comments