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

Skip to content

Commit 8a1e97b

Browse files
committed
docs: Update docs/README.md
1 parent 953ede5 commit 8a1e97b

File tree

1 file changed

+15
-17
lines changed

1 file changed

+15
-17
lines changed

docs/README.md

Lines changed: 15 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# DocsifyJS Tutorial homepage
22
> How to build a docs site using _DocsifyJS_ and _Github Pages_
33
4-
[![Made with latest Docsify](https://img.shields.io/npm/v/docsify?label=docsify)](https://docsify.js.org/)
5-
[![GitHub tag](https://img.shields.io/github/tag/MichaelCurrin/docsify-js-tutorial.svg)](https://GitHub.com/MichaelCurrin/docsify-js-tutorial/tags/)
6-
[![MIT license](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/MichaelCurrin/docsify-js-tutorial/blob/master/README.md#license)
4+
[![Made with Docsify latest](https://img.shields.io/npm/v/docsify?label=docsify&color=3271a8)](https://docsify.js.org/)
5+
[![GitHub tag](https://img.shields.io/github/tag/MichaelCurrin/docsify-js-tutorial?color=3271a8)](https://GitHub.com/MichaelCurrin/docsify-js-tutorial/tags/)
6+
[![MIT license](https://img.shields.io/badge/License-MIT-3271a8)](https://github.com/MichaelCurrin/docsify-js-tutorial/blob/master/README.md#license)
77

88
Convert your **docs** folder into a pretty docs website - using [DocsifyJS](https://docsify.js.org/) and some minimal setup instructions. This project's site itself is also running on _DocsifyJS_. :tada:
99

@@ -257,7 +257,7 @@ Example:
257257

258258
The clickable text above the standard sidebar takes you to the cover page. You can scroll down to the homepage (`docs/README.md`), but there are no links on the page to the homepage. So add a link to the Homepage with a first entry at the top.
259259

260-
Example of a link to the page page, using root page path and ID of the heading on the hompage.
260+
Example of a link to the page page, using root page path and ID of the heading on the homepage.
261261

262262
```markdown
263263
- [Home](/#my-app)
@@ -291,28 +291,26 @@ You can delete the cover page and disable it in _index.html_.
291291

292292
#### Cover background image
293293

294-
If you don't set a cover background, you'll get a different one on every refresh.
294+
You can change the background image for your cover page.
295+
296+
If you don't set a cover background, you'll just get a randomy one on every refresh. It might be a solid color or a gradient.
295297

296298
The _Docsify_ site explains how to set a background image or color [here](https://docsify.js.org/#/cover?id=custom-background).
297299

298-
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.
300+
Your background image code should come at the _bottom_ of your cover file's code._Docsify_ looks for an image there then uses CSS to place the image behind the content and give it faded grey look.
299301

300-
Examples:
302+
See code examples below for adding a custom background image:
301303

302-
- Load an image file. The label can be anything.
304+
- Solid color. The text label **must** be the word `color`.
303305
```markdown
304-
<!-- background image -->
305-
306-
![cover background image](_media/cover-bg.jpg)
306+
![color](#f0f0f0)
307307
```
308-
- Solid color. The label **must** be `color`.
308+
- Gradient color
309+
- Choose a gradient used to be supported but does not work anymore, so is not covered here.
310+
- Load an image file. The text label can be anything.
309311
```markdown
310-
<!-- background color -->
311-
312-
![color](#f0f0f0)
312+
![cover background image](_media/cover-bg.jpg)
313313
```
314-
- Gradient color - this used to be support but does not work anymore.
315-
316314

317315
#### Cover logo
318316

0 commit comments

Comments
 (0)