Skip to content

Commit f6ed6d3

Browse files
authored
docs: changes in sync Chinese translation (#2548)
1 parent 5d9ea4f commit f6ed6d3

12 files changed

+26
-26
lines changed

docs/adding-pages.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ docs/zh-cn/guide.md => http://domain.com/#/zh-cn/guide
2727

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

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

3232
```html
3333
<!-- index.html -->
@@ -115,7 +115,7 @@ A page's `title` tag is generated from the _selected_ sidebar item name. For bet
115115

116116
Once you've created `_sidebar.md`, the sidebar content is automatically generated based on the headers in the markdown files.
117117

118-
A custom sidebar can also automatically generate a table of contents by setting a `subMaxLevel`, compare [subMaxLevel configuration](configuration.md#submaxlevel).
118+
A custom sidebar can also automatically generate a table of contents by setting a `subMaxLevel`, compare [subMaxLevel configuration](configuration#submaxlevel).
119119

120120
```html
121121
<!-- index.html -->

docs/configuration.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -480,7 +480,7 @@ window.$docsify = {
480480
- Type: `Boolean`
481481
- Default: `false`
482482

483-
Render emoji shorthand codes using GitHub-style emoji images or platform-native emoji characters.
483+
Render emoji shorthand codes using GitHub-style emoji images or native emoji characters.
484484

485485
```js
486486
window.$docsify = {
@@ -506,7 +506,7 @@ GitHub-style images when `false`:
506506
<img class="emoji" src="https://github.githubassets.com/images/icons/emoji/unicode/1f44e.png" alt="-1">
507507
</output>
508508

509-
Platform-native characters when `true`:
509+
Native characters when `true`:
510510

511511
<output data-lang="output">
512512
<span class="emoji">😄︎</span>
@@ -581,7 +581,7 @@ To disable emoji parsing of individual shorthand codes, replace `:` characters w
581581

582582
## notFoundPage
583583

584-
- Type: `Boolean` | `String` | `Object`
584+
- Type: `Boolean|String|Object`
585585
- Default: `false`
586586

587587
Display default "404 - Not Found" message:

docs/cover.md

+2-2
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**. See [coverpage configuration](configuration.md#coverpage).
3+
Activate the cover feature by setting `coverpage` to **true**. See [coverpage configuration](configuration#coverpage).
44

55
## Basic usage
66

@@ -60,7 +60,7 @@ Alternatively, a background color or image can be specified in the cover page ma
6060

6161
## Coverpage as homepage
6262

63-
Normally, the coverpage and the homepage appear at the same time. Of course, you can also separate the coverpage by [`onlyCover`](configuration.md#onlycover) option.
63+
Normally, the coverpage and the homepage appear at the same time. Of course, you can also separate the coverpage by [`onlyCover`](configuration#onlycover) option.
6464

6565
## Multiple covers
6666

docs/custom-navbar.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ If you need custom navigation, you can create a HTML-based navigation bar.
2020

2121
## Markdown
2222

23-
Alternatively, you can create a custom markdown-based navigation file by setting `loadNavbar` to **true** and creating `_navbar.md`, compare [loadNavbar configuration](configuration.md#loadnavbar).
23+
Alternatively, you can create a custom markdown-based navigation file by setting `loadNavbar` to **true** and creating `_navbar.md`, compare [loadNavbar configuration](configuration#loadnavbar).
2424

2525
```html
2626
<!-- index.html -->

docs/deploy.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ server {
7878

7979
1. Login to your [Netlify](https://www.netlify.com/) account.
8080
2. In the [dashboard](https://app.netlify.com/) page, click **Add New Site**.
81-
3. Select Github.
81+
3. Select GitHub.
8282
4. Choose the repository where you store your docs, in the **Base Directory** add the subfolder where the files are stored. For example, it should be `docs`.
8383
5. In the **Build Command** area leave it blank.
8484
6. In the **Publish directory** area, if you have added the `docs` in the **Base Directory** you will see the publish directory populated with `docs/`

docs/markdown.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Markdown configuration
22

3-
**docsify** uses [marked v13+](https://github.com/markedjs/marked) as its Markdown parser. You can customize how it renders your Markdown content to HTML by customizing `renderer`:
3+
**docsify** uses [marked](https://github.com/markedjs/marked) as its Markdown parser. You can customize how it renders your Markdown content to HTML by customizing `renderer`:
44

55
```js
66
window.$docsify = {

docs/plugins.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Full text search
44

5-
By default, the hyperlink on the current page is recognized and the content is saved in `localStorage`. You can also specify the path to the files.
5+
By default, the hyperlink on the current page is recognized and the content is saved in `IndexedDB`. You can also specify the path to the files.
66

77
<!-- prettier-ignore -->
88
```html
@@ -188,7 +188,7 @@ Disqus comments. https://disqus.com/
188188

189189
## Gitalk
190190

191-
[Gitalk](https://github.com/gitalk/gitalk) is a modern comment component based on Github Issue and Preact.
191+
[Gitalk](https://github.com/gitalk/gitalk) is a modern comment component based on GitHub Issue and Preact.
192192

193193
```html
194194
<link rel="stylesheet" href="//cdn.jsdelivr.net/npm/gitalk/dist/gitalk.css" />
@@ -197,12 +197,12 @@ Disqus comments. https://disqus.com/
197197
<script src="//cdn.jsdelivr.net/npm/gitalk/dist/gitalk.min.js"></script>
198198
<script>
199199
const gitalk = new Gitalk({
200-
clientID: 'Github Application Client ID',
201-
clientSecret: 'Github Application Client Secret',
202-
repo: 'Github repo',
203-
owner: 'Github repo owner',
200+
clientID: 'GitHub Application Client ID',
201+
clientSecret: 'GitHub Application Client Secret',
202+
repo: 'GitHub repo',
203+
owner: 'GitHub repo owner',
204204
admin: [
205-
'Github repo collaborators, only these guys can initialize github issues',
205+
'GitHub repo collaborators, only these guys can initialize github issues',
206206
],
207207
// facebook-like distraction free mode
208208
distractionFreeMode: false,

docs/pwa.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ const getFixedUrl = req => {
3939
url.protocol = self.location.protocol;
4040

4141
// 2. add query for caching-busting.
42-
// Github Pages served with Cache-Control: max-age=600
42+
// GitHub Pages served with Cache-Control: max-age=600
4343
// max-age on mutable content is error-prone, with SW life of bugs can even extend.
4444
// Until cache mode of Fetch API landed, we have to workaround cache-busting with query string.
4545
// Cache-Control-Bug: https://bugs.chromium.org/p/chromium/issues/detail?id=453190

docs/quickstart.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@ You should set the `data-app` attribute if you changed `el`:
138138
</script>
139139
```
140140

141-
Compare [el configuration](configuration.md#el).
141+
Compare [el configuration](configuration#el).
142142

143143
<script>
144144
(function() {

docs/vue.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ Docsify ignores Vue template syntax within code blocks by default:
5151

5252
````markdown
5353
```
54-
{{ message}}
54+
{{ message }}
5555
```
5656
````
5757

@@ -61,7 +61,7 @@ To process Vue template syntax within a code block, wrap the code block in an el
6161
<div v-template>
6262

6363
```
64-
{{ message}}
64+
{{ message }}
6565
```
6666

6767
</div>

src/core/render/tpl.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ import { isMobile } from '../util/env.js';
22

33
/**
44
* Render github corner
5-
* @param {Object} data URL for the View Source on Github link
5+
* @param {Object} data URL for the View Source on GitHub link
66
* @param {String} cornerExternalLinkTarget value of the target attribute of the link
77
* @return {String} SVG element as string
88
*/
@@ -20,7 +20,7 @@ export function corner(data, cornerExternalLinkTarget) {
2020
cornerExternalLinkTarget = cornerExternalLinkTarget || '_blank';
2121

2222
return /* html */ `
23-
<a href="${data}" target="${cornerExternalLinkTarget}" class="github-corner" aria-label="View source on Github">
23+
<a href="${data}" target="${cornerExternalLinkTarget}" class="github-corner" aria-label="View source on GitHub">
2424
<svg viewBox="0 0 250 250" aria-hidden="true">
2525
<path d="M0,0 L115,115 L130,115 L142,142 L250,250 L250,0 Z"></path>
2626
<path d="M128.3,109.0 C113.8,99.7 119.0,89.6 119.0,89.6 C122.0,82.7 120.5,78.6 120.5,78.6 C119.2,72.0 123.4,76.3 123.4,76.3 C127.3,80.9 125.5,87.3 125.5,87.3 C122.9,97.6 130.6,101.9 134.4,103.2" fill="currentColor" style="transform-origin: 130px 106px;" class="octo-arm"></path>

test/e2e/search.test.js

+3-3
Original file line numberDiff line numberDiff line change
@@ -57,11 +57,11 @@ test.describe('Search Plugin Tests', () => {
5757
5858
## GitHub Pages ignore1 <!-- {docsify-ignore} -->
5959
60-
There're three places to populate your docs for your Github repository1.
60+
There're three places to populate your docs for your GitHub repository1.
6161
6262
## GitHub Pages ignore2 {docsify-ignore}
6363
64-
There're three places to populate your docs for your Github repository2.
64+
There're three places to populate your docs for your GitHub repository2.
6565
`,
6666
},
6767
scriptURLs: ['/dist/plugins/search.js'],
@@ -288,7 +288,7 @@ console.log('Hello World');
288288
markdown: {
289289
homepage: `
290290
# Hello World
291-
291+
292292
- [ ] Task 1
293293
- [x] SearchHere
294294
- [ ] Task 3

0 commit comments

Comments
 (0)