Skip to content

Commit 74a0af0

Browse files
authored
Merge branch 'develop' into develop
2 parents cf05a6f + 97806cb commit 74a0af0

File tree

13 files changed

+104
-101
lines changed

13 files changed

+104
-101
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 = {
@@ -273,7 +273,7 @@ window.$docsify = {
273273

274274
- Type: `String`
275275

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

278278
```js
279279
window.$docsify = {
@@ -350,7 +350,7 @@ window.$docsify = {
350350

351351
- Type: `String`
352352

353-
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.
353+
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.
354354

355355
```js
356356
window.$docsify = {
@@ -380,7 +380,7 @@ window.$docsify = {
380380

381381
- type: `Boolean`
382382

383-
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).
383+
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).
384384

385385
```js
386386
window.$docsify = {
@@ -393,7 +393,7 @@ window.$docsify = {
393393

394394
- type: `Boolean`
395395

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

398398
```js
399399
window.$docsify = {
@@ -423,7 +423,7 @@ window.$docsify = {
423423
};
424424
```
425425

426-
?> 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)
426+
?> 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)
427427
428428
## mergeNavbar
429429
@@ -510,8 +510,8 @@ window.$docsify = {
510510

511511
- type: `Array`
512512

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

516516
```js
517517
window.$docsify = {
@@ -583,7 +583,7 @@ window.$docsify = {
583583

584584
- type: `Array<string>`
585585

586-
List of languages that will fallback to the default language when a page is requested and it doesn't exist for the given local.
586+
List of languages that will fallback to the default language when a page is requested and it doesn't exist for the given locale.
587587
588588
Example:
589589
@@ -628,14 +628,14 @@ window.$docsify = {
628628
};
629629
```
630630
631-
> Note: The options with fallbackLanguages didn't work with the `notFoundPage` options.
631+
> Note: The options for fallbackLanguages don't work with the `notFoundPage` options.
632632

633633
## topMargin
634634

635635
- type: `Number`
636636
- default: `0`
637637

638-
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.
638+
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.
639639

640640
```js
641641
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/embed-files.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Then the content of `example.md` will be displayed directly here;
1616

1717
You can check the original content for [example.md](_media/example.md ':ignore').
1818

19-
Normally, this will compiled into a link, but in docsify, if you add `:include` it will be embedded.
19+
Normally, this will compiled into a link, but in docsify, if you add `:include` it will be embedded. You can use single or double quotation marks around as you like.
2020

2121
External links can be used too - just replace the target. If you want to use a gist URL, see [Embed a gist](#embed-a-gist) section.
2222

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: 3 additions & 2 deletions
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 = {
@@ -87,7 +87,7 @@ window.$docsify = {
8787
editHtml +
8888
html +
8989
'\n----\n' +
90-
'Last modified {docsify-updated} ' +
90+
'Last modified {docsify-updated}' +
9191
editHtml
9292
);
9393
});
@@ -108,4 +108,5 @@ Current version: <span id='tip-version'>loading</span>
108108

109109
<script>
110110
document.getElementById('tip-version').innerText = Docsify.version
111+
document.getElementsByClassName("lang-js")[2].innerHTML = document.getElementsByClassName("lang-js")[2].innerHTML.replace(/Last modified .*'/,"Last modified {docsify-updated<span>}'</span>")
111112
</script>

package-lock.json

Lines changed: 32 additions & 32 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@
5454
"*.js": "eslint --fix"
5555
},
5656
"dependencies": {
57-
"dompurify": "^2.2.8",
57+
"dompurify": "^2.2.9",
5858
"marked": "^1.2.9",
5959
"medium-zoom": "^1.0.6",
6060
"opencollective-postinstall": "^2.0.2",

packages/docsify-server-renderer/package-lock.json

Lines changed: 3 additions & 44 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)