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

Clean up readme (#48)

Browse source 
* Readme/homepage cleanup

* Readme cleanup
This commit is contained in:
Sina Nedadahandeh 2017-01-04 18:31:41 -08:00 • committed by cinwell.li
commit 356b937d44
1 changed files with 6 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

12
docs/README.md
View file

@ -98,7 +98,7 @@ Code in `index.html`
### Cover Page ### 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 ```markdown
![logo](_media/icon.svg) ![logo](_media/icon.svg)
@ -117,7 +117,7 @@ Generate a cover page through with markdown. Create a `_coverpage.md` and set `d
``` ```
#### Custom background #### 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 ```markdown
# docsify <small>1.2.0</small> # docsify <small>1.2.0</small>
@ -135,7 +135,7 @@ Currently the background of cover page is generated randomly. We can customize t
### Markdown parser ### 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 ```js
window.$docsify = { window.$docsify = {
@ -145,7 +145,7 @@ window.$docsify = {
} }
``` ```
And can even be completely customized And it can even be customized
```js ```js
window.$docsify = { window.$docsify = {
@ -159,7 +159,7 @@ window.$docsify = {
## Options ## 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 ### repo
Display the [GitHub Corner](http://tholman.com/github-corners/) widget. Display the [GitHub Corner](http://tholman.com/github-corners/) widget.
@ -247,7 +247,7 @@ window.$docsify = {
### load-sidebar ### 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`** ** you should add `.nojekyll` into docs folder to prevent GitHub Pages from ignoring the `_sidebar.md`**
```html ```html