Skip to content

docs: improve English wording (Getting Started/Customization) #1617

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 30, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 11 additions & 11 deletions docs/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`, to 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 @@ -260,7 +260,7 @@ window.$docsify = {

- Type: `String`

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

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

- Type: `String`

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.
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.

```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. See [#78](https://github.com/docsifyjs/docsify/issues/78).

```js
window.$docsify = {
Expand All @@ -380,7 +380,7 @@ window.$docsify = {

- type: `Boolean`

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

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

?> 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)
?> 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)

## mergeNavbar

Expand Down Expand Up @@ -497,8 +497,8 @@ window.$docsify = {

- type: `Array`

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

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

- type: `Array<string>`

List of languages that will fallback to the default language when a page is requested and it doesn't exist 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 locale.

Example:

Expand Down Expand Up @@ -615,14 +615,14 @@ window.$docsify = {
};
```

> Note: The options with fallbackLanguages didn't work with the `notFoundPage` options.
> Note: The options for fallbackLanguages don't work with the `notFoundPage` options.

## topMargin

- type: `Number`
- default: `0`

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.
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.

```js
window.$docsify = {
Expand Down
2 changes: 1 addition & 1 deletion docs/cover.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Cover

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

## Basic usage

Expand Down
4 changes: 2 additions & 2 deletions docs/markdown.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@ window.$docsify = {
}
```

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

Even you can completely customize the parsing rules.
You can completely customize the parsing rules.

```js
window.$docsify = {
Expand Down
4 changes: 2 additions & 2 deletions docs/more-pages.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ docs/zh-cn/guide.md => http://domain.com/#/zh-cn/guide

## Sidebar

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):
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):

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

Expand Down Expand Up @@ -65,7 +65,7 @@ Example file structure:

## Nested Sidebars

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.
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.

`_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`.

Expand Down
2 changes: 1 addition & 1 deletion docs/plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ Exclude the special image

## Edit on github

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)
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)

## Demo code with instant preview and jsfiddle integration

Expand Down
2 changes: 1 addition & 1 deletion docs/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ If you prefer to lock docsify to a specific version, specify the full version af

### Manually preview your site

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

```python2
cd docs && python -m SimpleHTTPServer 3000
Expand Down
2 changes: 1 addition & 1 deletion docs/write-a-plugin.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ window.$docsify = {

#### footer

Add footer component in each pages.
Add a footer component to each page.

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