You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/configuration.md
+11-11Lines changed: 11 additions & 11 deletions
Original file line number
Diff line number
Diff line change
@@ -48,7 +48,7 @@ window.$docsify = {
48
48
- Type: `String`
49
49
- Default: `null`
50
50
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.
52
52
53
53
```js
54
54
window.$docsify= {
@@ -260,7 +260,7 @@ window.$docsify = {
260
260
261
261
- Type: `String`
262
262
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.
264
264
265
265
```js
266
266
window.$docsify= {
@@ -337,7 +337,7 @@ window.$docsify = {
337
337
338
338
- Type: `String`
339
339
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.
341
341
342
342
```js
343
343
window.$docsify= {
@@ -367,7 +367,7 @@ window.$docsify = {
367
367
368
368
- type: `Boolean`
369
369
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).
371
371
372
372
```js
373
373
window.$docsify= {
@@ -380,7 +380,7 @@ window.$docsify = {
380
380
381
381
- type: `Boolean`
382
382
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.
384
384
385
385
```js
386
386
window.$docsify= {
@@ -410,7 +410,7 @@ window.$docsify = {
410
410
};
411
411
```
412
412
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)
414
414
415
415
## mergeNavbar
416
416
@@ -497,8 +497,8 @@ window.$docsify = {
497
497
498
498
- type: `Array`
499
499
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).
502
502
503
503
```js
504
504
window.$docsify= {
@@ -570,7 +570,7 @@ window.$docsify = {
570
570
571
571
- type: `Array<string>`
572
572
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.
574
574
575
575
Example:
576
576
@@ -615,14 +615,14 @@ window.$docsify = {
615
615
};
616
616
```
617
617
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.
619
619
620
620
## topMargin
621
621
622
622
- type: `Number`
623
623
- default: `0`
624
624
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.
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):
29
29
30
30
First, you need to set `loadSidebar` to **true**. Details are available in the [configuration paragraph](configuration.md#loadsidebar).
31
31
@@ -65,7 +65,7 @@ Example file structure:
65
65
66
66
## Nested Sidebars
67
67
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.
69
69
70
70
`_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`.
Copy file name to clipboardExpand all lines: docs/plugins.md
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -123,7 +123,7 @@ Exclude the special image
123
123
124
124
## Edit on github
125
125
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)
127
127
128
128
## Demo code with instant preview and jsfiddle integration
0 commit comments