Skip to content

Commit 356b937

Browse files
nsinaQingWei-Li
authored andcommitted
Clean up readme (#48)
* Readme/homepage cleanup * Readme cleanup
1 parent 8df57f0 commit 356b937

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

docs/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ Code in `index.html`
9898

9999
### Cover Page
100100

101-
Generate a cover page through with markdown. Create a `_coverpage.md` and set `data-coverpage` in script tag.
101+
Generate a cover page with markdown. Create a `_coverpage.md` and set `data-coverpage` in the script tag.
102102

103103
```markdown
104104
![logo](_media/icon.svg)
@@ -117,7 +117,7 @@ Generate a cover page through with markdown. Create a `_coverpage.md` and set `d
117117
```
118118

119119
#### Custom background
120-
Currently the background of cover page is generated randomly. We can customize the background, just using the syntax to add image.
120+
Currently the background of the cover page is generated randomly. We can customize the background color, or add a background image.
121121

122122
```markdown
123123
# docsify <small>1.2.0</small>
@@ -135,7 +135,7 @@ Currently the background of cover page is generated randomly. We can customize t
135135

136136
### Markdown parser
137137

138-
Docsify uses [marked](https://github.com/chjj/marked) to parse markdown, we can configure it
138+
Docsify uses [marked](https://github.com/chjj/marked) to parse markdown. We can configure it
139139

140140
```js
141141
window.$docsify = {
@@ -145,7 +145,7 @@ window.$docsify = {
145145
}
146146
```
147147

148-
And can even be completely customized
148+
And it can even be customized
149149

150150
```js
151151
window.$docsify = {
@@ -159,7 +159,7 @@ window.$docsify = {
159159

160160
## Options
161161

162-
You can add configuration by script tag attributes or `window.$docsify`.
162+
You can add configurations in the script tag attributes or with `window.$docsify`.
163163

164164
### repo
165165
Display the [GitHub Corner](http://tholman.com/github-corners/) widget.
@@ -247,7 +247,7 @@ window.$docsify = {
247247

248248
### load-sidebar
249249

250-
Load sidebar markdown file. If it is configured, load the current directory `_sidebar.md` by default. If the file isn't exist, sidebar will appear as a TOC.
250+
Load sidebar markdown file. If it is configured, load the current directory `_sidebar.md` by default. If the file doesn't exist, the sidebar will appear as a TOC.
251251
** you should add `.nojekyll` into docs folder to prevent GitHub Pages from ignoring the `_sidebar.md`**
252252

253253
```html

0 commit comments

Comments
 (0)