Skip to content

Commit 97806cb

Browse files
authored
docs: improve English wording (Getting Started/Customization) (#1617)
While referencing the documentation, I noticed a few phrases that could be changed to sound more natural. I tried to keep the original meanings.
1 parent 9d7dcd5 commit 97806cb

File tree

7 files changed

+19
-19
lines changed

7 files changed

+19
-19
lines changed

docs/configuration.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ window.$docsify = {
4848
- Type: `String`
4949
- Default: `null`
5050

51-
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.
51+
Configure the repository url, or a string of `username/repo`, to add the [GitHub Corner](http://tholman.com/github-corners/) widget in the top right corner of the site.
5252

5353
```js
5454
window.$docsify = {
@@ -260,7 +260,7 @@ window.$docsify = {
260260

261261
- Type: `String`
262262

263-
Website logo as it appears in the sidebar. You can resize it by using CSS.
263+
Website logo as it appears in the sidebar. You can resize it using CSS.
264264

265265
```js
266266
window.$docsify = {
@@ -337,7 +337,7 @@ window.$docsify = {
337337

338338
- Type: `String`
339339

340-
Customize the theme color. Use [CSS3 variables](https://developer.mozilla.org/en-US/docs/Web/CSS/Using_CSS_variables) feature and polyfill in old browser.
340+
Customize the theme color. Use [CSS3 variables](https://developer.mozilla.org/en-US/docs/Web/CSS/Using_CSS_variables) feature and polyfill in older browsers.
341341

342342
```js
343343
window.$docsify = {
@@ -367,7 +367,7 @@ window.$docsify = {
367367

368368
- type: `Boolean`
369369

370-
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).
370+
If `loadSidebar` and `autoHeader` are both enabled, for each link in `_sidebar.md`, prepend a header to the page before converting it to HTML. See [#78](https://github.com/docsifyjs/docsify/issues/78).
371371

372372
```js
373373
window.$docsify = {
@@ -380,7 +380,7 @@ window.$docsify = {
380380

381381
- type: `Boolean`
382382

383-
Execute the script on the page. Only parse the first script tag([demo](themes)). If Vue is present, it is turned on by default.
383+
Execute the script on the page. Only parse the first script tag ([demo](themes)). If Vue is present, it is turned on by default.
384384

385385
```js
386386
window.$docsify = {
@@ -410,7 +410,7 @@ window.$docsify = {
410410
};
411411
```
412412

413-
?> If this options is `false` but you don't want to emojify some specific colons , [Refer this](https://github.com/docsifyjs/docsify/issues/742#issuecomment-586313143)
413+
?> If this option is `false` but you don't want to emojify some specific colons, [refer to this](https://github.com/docsifyjs/docsify/issues/742#issuecomment-586313143)
414414

415415
## mergeNavbar
416416

@@ -497,8 +497,8 @@ window.$docsify = {
497497

498498
- type: `Array`
499499

500-
When `routerMode: 'history'`, you may face the cross-origin issues, See [#1379](https://github.com/docsifyjs/docsify/issues/1379).
501-
In Markdown content, there is a simple way to solve it, see extends Markdown syntax `Cross-Origin link` in [helpers](helpers.md).
500+
When `routerMode: 'history'`, you may face cross-origin issues. See [#1379](https://github.com/docsifyjs/docsify/issues/1379).
501+
In Markdown content, there is a simple way to solve it: see extends Markdown syntax `Cross-Origin link` in [helpers](helpers.md).
502502

503503
```js
504504
window.$docsify = {
@@ -570,7 +570,7 @@ window.$docsify = {
570570

571571
- type: `Array<string>`
572572

573-
List of languages that will fallback to the default language when a page is requested and it doesn't exist for the given local.
573+
List of languages that will fallback to the default language when a page is requested and it doesn't exist for the given locale.
574574

575575
Example:
576576

@@ -615,14 +615,14 @@ window.$docsify = {
615615
};
616616
```
617617

618-
> Note: The options with fallbackLanguages didn't work with the `notFoundPage` options.
618+
> Note: The options for fallbackLanguages don't work with the `notFoundPage` options.
619619
620620
## topMargin
621621

622622
- type: `Number`
623623
- default: `0`
624624

625-
Adds a space on top when scrolling content page to reach the selected section. This is useful in case you have a _sticky-header_ layout and you want to align anchors to the end of your header.
625+
Adds a space on top when scrolling the content page to reach the selected section. This is useful in case you have a _sticky-header_ layout and you want to align anchors to the end of your header.
626626

627627
```js
628628
window.$docsify = {

docs/cover.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Cover
22

3-
Activate the cover feature by setting `coverpage` to **true**, compare [coverpage configuration](configuration.md#coverpage).
3+
Activate the cover feature by setting `coverpage` to **true**. See [coverpage configuration](configuration.md#coverpage).
44

55
## Basic usage
66

docs/markdown.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@ window.$docsify = {
1515
}
1616
```
1717

18-
?> Configuration Options Reference [marked documentation](https://marked.js.org/#/USING_ADVANCED.md)
18+
?> Configuration Options Reference: [marked documentation](https://marked.js.org/#/USING_ADVANCED.md)
1919

20-
Even you can completely customize the parsing rules.
20+
You can completely customize the parsing rules.
2121

2222
```js
2323
window.$docsify = {

docs/more-pages.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ docs/zh-cn/guide.md => http://domain.com/#/zh-cn/guide
2525

2626
## Sidebar
2727

28-
In order to have sidebar, then you can create your own `_sidebar.md` (see [this documentation's sidebar](https://github.com/docsifyjs/docsify/blob/master/docs/_sidebar.md) for an example):
28+
In order to have a sidebar, you can create your own `_sidebar.md` (see [this documentation's sidebar](https://github.com/docsifyjs/docsify/blob/master/docs/_sidebar.md) for an example):
2929

3030
First, you need to set `loadSidebar` to **true**. Details are available in the [configuration paragraph](configuration.md#loadsidebar).
3131

@@ -65,7 +65,7 @@ Example file structure:
6565

6666
## Nested Sidebars
6767

68-
You may want the sidebar to update with only navigation to reflect the current directory. This can be done by adding a `_sidebar.md` file to each folder.
68+
You may want the sidebar to update after navigation to reflect the current directory. This can be done by adding a `_sidebar.md` file to each folder.
6969

7070
`_sidebar.md` is loaded from each level directory. If the current directory doesn't have `_sidebar.md`, it will fall back to the parent directory. If, for example, the current path is `/guide/quick-start`, the `_sidebar.md` will be loaded from `/guide/_sidebar.md`.
7171

docs/plugins.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ Exclude the special image
123123

124124
## Edit on github
125125

126-
Add `Edit on github` button on every pages. Provided by [@njleonzhang](https://github.com/njleonzhang), check [document](https://github.com/njleonzhang/docsify-edit-on-github)
126+
Add `Edit on github` button on every pages. Provided by [@njleonzhang](https://github.com/njleonzhang), see this [document](https://github.com/njleonzhang/docsify-edit-on-github)
127127

128128
## Demo code with instant preview and jsfiddle integration
129129

docs/quickstart.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ If you prefer to lock docsify to a specific version, specify the full version af
8181

8282
### Manually preview your site
8383

84-
If you installed python on your system, you can easily use it to run a static server to preview your site.
84+
If you have Python installed on your system, you can easily use it to run a static server to preview your site.
8585

8686
```python2
8787
cd docs && python -m SimpleHTTPServer 3000

docs/write-a-plugin.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ window.$docsify = {
4949

5050
#### footer
5151

52-
Add footer component in each pages.
52+
Add a footer component to each page.
5353

5454
```js
5555
window.$docsify = {

0 commit comments

Comments
 (0)