Skip to content

Commit

Permalink
chore: grammatical changes (#1296)
Browse files Browse the repository at this point in the history
* Make grammatical changes

Minor changes.
Solely for improving readability.

* Update changes

Co-authored-by: 沈唁 <52o@qq52o.cn>
  • Loading branch information
bharat-patodi and sy-records authored Jul 26, 2020
1 parent aec03d4 commit 1a64dc8
Showing 1 changed file with 16 additions and 16 deletions.
32 changes: 16 additions & 16 deletions docs/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ You can configure Docsify by defining `window.$docsify` as an object:
</script>
```

The config can also be defined as a function, in which case the first arg is the Docsify `vm` instance. The function should return a config object. This can be useful for referencing `vm` in places like the markdown configuration:
The config can also be defined as a function, in which case the first argument is the Docsify `vm` instance. The function should return a config object. This can be useful for referencing `vm` in places like the markdown configuration:

```html
<script>
Expand All @@ -35,7 +35,7 @@ The config can also be defined as a function, in which case the first arg is the
- Type: `String`
- Default: `#app`

The DOM element to be mounted on initialization. It can be a CSS selector string or an actual HTMLElement.
The DOM element to be mounted on initialization. It can be a CSS selector string or an actual [HTMLElement](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement).

```js
window.$docsify = {
Expand All @@ -48,7 +48,7 @@ window.$docsify = {
- Type: `String`
- Default: `null`

Configure the repository url or a string of `username/repo` can add the [GitHub Corner](http://tholman.com/github-corners/) widget in the top right corner of the site.
Configure the repository url, or a string of `username/repo` can add the [GitHub Corner](http://tholman.com/github-corners/) widget in the top right corner of the site.

```js
window.$docsify = {
Expand Down Expand Up @@ -76,7 +76,7 @@ window.$docsify = {
- Type: `Boolean|String`
- Default: `false`

Loads navbar from the Markdown file `_navbar.md` if **true**, or else from the path specified.
Loads navbar from the Markdown file `_navbar.md` if **true**, else loads it from the path specified.

```js
window.$docsify = {
Expand All @@ -93,7 +93,7 @@ window.$docsify = {
- Type: `Boolean|String`
- Default: `false`

Loads sidebar from the Markdown file `_sidebar.md` if **true**, or else from the path specified.
Loads sidebar from the Markdown file `_sidebar.md` if **true**, else loads it from the path specified.

```js
window.$docsify = {
Expand All @@ -110,7 +110,7 @@ window.$docsify = {
- Type : `Boolean`
- Default: `true`

This option will completely hide your sidebar and wont render any content of the side even .
This option will completely hide your sidebar and won't render any content on the side.

```js
window.$docsify = {
Expand Down Expand Up @@ -149,7 +149,7 @@ window.$docsify = {
- Type: `String`
- Default: `README.md`

`README.md` in your docs folder will be treated as homepage for your website, but sometimes you may need to serve another file as your homepage.
`README.md` in your docs folder will be treated as the homepage for your website, but sometimes you may need to serve another file as your homepage.

```js
window.$docsify = {
Expand Down Expand Up @@ -196,7 +196,7 @@ window.$docsify = {
- Type: `Boolean`
- Default: `false`

If **true** links are relative to the current context.
If **true**, links are relative to the current context.

For example, the directory structure is as follows:

Expand Down Expand Up @@ -260,7 +260,7 @@ window.$docsify = {

- Type: `String`

Website logo as it appears in the sidebar, you can resize by CSS.
Website logo as it appears in the sidebar. You can resize it by using CSS.

```js
window.$docsify = {
Expand Down Expand Up @@ -367,7 +367,7 @@ window.$docsify = {

- type: `Boolean`

If `loadSidebar` and `autoHeader` are both enabled, for each link in `_sidebar.md`, prepend a header to the page before converting it to html. Compare [#78](https://github.com/docsifyjs/docsify/issues/78).
If `loadSidebar` and `autoHeader` are both enabled, for each link in `_sidebar.md`, prepend a header to the page before converting it to HTML. Compare [#78](https://github.com/docsifyjs/docsify/issues/78).

```js
window.$docsify = {
Expand Down Expand Up @@ -474,7 +474,7 @@ window.$docsify = {
- type: `String`
- default: `noopener`

Default `'noopener'` (no opener) prevents the newly opened external page (when [externalLinkTarget](#externallinktarget) is `'_blank'`) from having the ability to control our page. No `rel` is set when its not `'_blank'`. See [this post](https://mathiasbynens.github.io/rel-noopener/) for more information about why you may want to use this option.
Default `'noopener'` (no opener) prevents the newly opened external page (when [externalLinkTarget](#externallinktarget) is `'_blank'`) from having the ability to control our page. No `rel` is set when it's not `'_blank'`. See [this post](https://mathiasbynens.github.io/rel-noopener/) for more information about why you may want to use this option.

```js
window.$docsify = {
Expand Down Expand Up @@ -557,13 +557,13 @@ window.$docsify = {

- type: `Array<string>`

List of languages that will fallback to the default language when a page is request and didn't exists for the given local.
List of languages that will fallback to the default language when a page is requested and it doesn't exist for the given local.

Example:

- try to fetch the page of `/de/overview`. If this page exists, it'll be displayed
- then try to fetch the default page `/overview` (depending on the default language). If this page exists, it'll be displayed
- then display 404 page.
- try to fetch the page of `/de/overview`. If this page exists, it'll be displayed.
- then try to fetch the default page `/overview` (depending on the default language). If this page exists, it'll be displayed.
- then display the 404 page.

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

Load the customised path of the 404 page:
Load the customized path of the 404 page:

```js
window.$docsify = {
Expand Down

1 comment on commit 1a64dc8

@vercel
Copy link

@vercel vercel bot commented on 1a64dc8 Jul 26, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.