From b4f3490eb804d0ad704eec29f6e91f21bbf02fd2 Mon Sep 17 00:00:00 2001 From: nsina Date: Fri, 30 Dec 2016 10:27:04 -0800 Subject: [PATCH 1/2] Readme/homepage cleanup --- docs/README.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/README.md b/docs/README.md index 9c5752c88..d76555f6f 100644 --- a/docs/README.md +++ b/docs/README.md @@ -29,7 +29,7 @@ Create `README.md` as the main page ``` # Title -## balabala +## blabla ``` ### Deploy! @@ -38,7 +38,7 @@ Push and open the **GitHub Pages** feature ## CLI -Easy to setup and preivew a docs. +Easy to setup and preview a docs. ### Install ```shell @@ -96,7 +96,7 @@ Code in `index.html` ### Cover Page -Through the markdown can generate a cover page. create a `_coverpage.md` and set `data-coverpage` in script tag. +Generate a cover page through with markdown. Create a `_coverpage.md` and set `data-coverpage` in script tag. ```markdown ![logo](_media/icon.svg) @@ -125,7 +125,7 @@ Display the [GitHub Corner](http://tholman.com/github-corners/) widget. ``` #### max-level -Toc level. +TOC level. ```html @@ -148,7 +148,7 @@ Sidebar with toggle #### sidebar -Custom sidebar. if it'set, the TOC will be disabeld. Bind global variables on the `data-sidebar`. +Custom sidebar. If it's set, the TOC will be disabled. Bind global variables on the `data-sidebar`. ![image](https://cloud.githubusercontent.com/assets/7565692/20647425/de5ab1c2-b4ce-11e6-863a-135868f2f9b4.png) @@ -172,8 +172,8 @@ Custom sidebar. if it'set, the TOC will be disabeld. Bind global variables on th #### 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 TOC. -** you should add `.nojekyll` into docs folder, to prevent GitHub Pages from ignoring the `_sidebar.md`** +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. +** you should add `.nojekyll` into docs folder to prevent GitHub Pages from ignoring the `_sidebar.md`** ```html @@ -215,7 +215,7 @@ Display TOC in the custom sidebar. The default value is 0. #### load-navbar -Load navbar markdown file. If it is configured, load the current directory `_navbar.md` by default. +Load navbar markdown file. If it is configured, load the current directory `_navbar.md` by default. ```html @@ -262,7 +262,7 @@ Scroll to the top on changing hash. #### homepage -`README.md` will be render as homepage for your website in docs folder, but sometimes we want to specify another file as a homepage, or even use the `README.md` in your repo. we can use (need `data-router`): +`README.md` will be rendered as a homepage for your website in the docs folder, but sometimes we want to specify another file as a homepage, or even use the `README.md` in your repo. We can use (need `data-router`): ```html From 66a26b3c721d59164ad47f1320e4f164dce55ce8 Mon Sep 17 00:00:00 2001 From: nsina Date: Wed, 4 Jan 2017 13:23:12 -0800 Subject: [PATCH 2/2] Readme cleanup --- docs/README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/README.md b/docs/README.md index 405495b15..3a6d0dff0 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