Skip to content

Clean up readme #48

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Jan 5, 2017
Merged

Clean up readme #48

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
b4f3490
Readme/homepage cleanup
nsina Dec 30, 2016
de17ff1
Merge pull request #1 from QingWei-Li/master
nsina Dec 31, 2016
93b1585
Merge pull request #2 from QingWei-Li/master
nsina Jan 2, 2017
3963cb9
Merge pull request #3 from QingWei-Li/master
nsina Jan 3, 2017
fdbe115
Merge pull request #4 from QingWei-Li/master
nsina Jan 4, 2017
66a26b3
Readme cleanup
nsina Jan 4, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ Code in `index.html`

### Cover Page

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

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

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

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

### Markdown parser

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

```js
window.$docsify = {
Expand All @@ -145,7 +145,7 @@ window.$docsify = {
}
```

And can even be completely customized
And it can even be customized

```js
window.$docsify = {
Expand All @@ -159,7 +159,7 @@ window.$docsify = {

## Options

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

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

### load-sidebar

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.
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.
** you should add `.nojekyll` into docs folder to prevent GitHub Pages from ignoring the `_sidebar.md`**

```html
Expand Down