|
1 | 1 | # DocsifyJS Tutorial homepage
|
2 | 2 | > How to build a docs site using _DocsifyJS_ and _Github Pages_
|
3 | 3 |
|
4 |
| -[](https://docsify.js.org/) |
5 |
| -[](https://GitHub.com/MichaelCurrin/docsify-js-tutorial/tags/) |
6 |
| -[](https://github.com/MichaelCurrin/docsify-js-tutorial/blob/master/README.md#license) |
| 4 | +[](https://docsify.js.org/) |
| 5 | +[](https://GitHub.com/MichaelCurrin/docsify-js-tutorial/tags/) |
| 6 | +[](https://github.com/MichaelCurrin/docsify-js-tutorial/blob/master/README.md#license) |
7 | 7 |
|
8 | 8 | 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:
|
9 | 9 |
|
@@ -257,7 +257,7 @@ Example:
|
257 | 257 |
|
258 | 258 | 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.
|
259 | 259 |
|
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. |
261 | 261 |
|
262 | 262 | ```markdown
|
263 | 263 | - [Home](/#my-app)
|
@@ -291,28 +291,26 @@ You can delete the cover page and disable it in _index.html_.
|
291 | 291 |
|
292 | 292 | #### Cover background image
|
293 | 293 |
|
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. |
295 | 297 |
|
296 | 298 | The _Docsify_ site explains how to set a background image or color [here](https://docsify.js.org/#/cover?id=custom-background).
|
297 | 299 |
|
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. |
299 | 301 |
|
300 |
| -Examples: |
| 302 | +See code examples below for adding a custom background image: |
301 | 303 |
|
302 |
| -- Load an image file. The label can be anything. |
| 304 | +- Solid color. The text label **must** be the word `color`. |
303 | 305 | ```markdown
|
304 |
| - <!-- background image --> |
305 |
| - |
306 |
| -  |
| 306 | +  |
307 | 307 | ```
|
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. |
309 | 311 | ```markdown
|
310 |
| - <!-- background color --> |
311 |
| - |
312 |
| -  |
| 312 | +  |
313 | 313 | ```
|
314 |
| -- Gradient color - this used to be support but does not work anymore. |
315 |
| - |
316 | 314 |
|
317 | 315 | #### Cover logo
|
318 | 316 |
|
|
0 commit comments