From 356b937d443f9f74bec7c08f8aaef81c32436f95 Mon Sep 17 00:00:00 2001 From: Sina Nedadahandeh Date: Wed, 4 Jan 2017 18:31:41 -0800 Subject: [PATCH] Clean up readme (#48) * Readme/homepage cleanup * Readme cleanup --- docs/README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/README.md b/docs/README.md index 405495b..3a6d0df 100644 --- a/docs/README.md +++ b/docs/README.md @@ -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) @@ -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 1.2.0 @@ -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 = { @@ -145,7 +145,7 @@ window.$docsify = { } ``` -And can even be completely customized +And it can even be customized ```js window.$docsify = { @@ -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. @@ -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