jyapayne/docsify
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

update english docs

Browse source
This commit is contained in:
Johannes Rappen 2017-03-09 22:19:07 +01:00
commit 6eada5a2f7
19 changed files with 159 additions and 129 deletions
Download patch file Download diff file Expand all files Collapse all files

15
docs/cover.md
View file

@ -1,6 +1,6 @@
# Cover
Activate the cover feature by setting `coverpage` to **true**. Details are available in the [coverpage configuration paragraph](configuration#coverpage).
Activate the cover feature by setting `coverpage` to **true**, compare [coverpage configuration](configuration#coverpage).
## Basic usage
@ -14,16 +14,15 @@ Set `coverpage` to **true**, and create a `_coverpage.md`:
coverpage: true
}
</script>
<script src="//unpkg.com/docsify"></script>
<script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
```
```markdown
<!-- _coverpage.md -->
![logo](_media/icon.svg)
# docsify <small>3.0</small>
# docsify <small>3.5</small>
> A magical documentation site generator.
@ -31,27 +30,27 @@ Set `coverpage` to **true**, and create a `_coverpage.md`:
- No statically built html files
- Multiple themes
[GitHub](https://github.com/QingWei-Li/docsify/)
[Get Started](#docsify)
```
!> A document site can have only one cover page.
!> A document site can have only one coverpage!
## Custom background
The background color is generated randomly by default. You can customize the background color or image:
The background color is generated randomly by default. You can customize the background color or a background image:
```markdown
<!-- _coverpage.md -->
# docsify
# docsify <small>3.5</small>
[GitHub](https://github.com/QingWei-Li/docsify/)
[Get Started](#quick-start)
<!-- background image -->
![](_media/bg.png)
<!-- background color -->
![color](#f0f0f0)
```