Skip to content

Commit 2440783

Browse files
authored
Merge branch 'develop' into patch-2
2 parents cad1fe9 + 0dd44cc commit 2440783

File tree

14 files changed

+213
-173
lines changed

14 files changed

+213
-173
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 45 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,65 @@
1-
<!-- Please use English language -->
2-
<!-- Please don't delete this template -->
1+
<!--
2+
PULL REQUEST TEMPLATE
3+
---
4+
Please use English language
5+
Please don't delete this template
6+
---
7+
Update "[ ]" to "[x]" to check a box in any list below.
8+
---
9+
To avoid wasting your time, it's best to open a **feature request issue** first and wait for approval before working on it.
10+
-->
311

4-
<!-- PULL REQUEST TEMPLATE -->
5-
<!-- (Update "[ ]" to "[x]" to check a box) -->
12+
## **Summary**
613

7-
**Summary**
14+
<!--
15+
THIS IS REQUIRED! Please describe what the change does and why it should be merged.
16+
-->
817

9-
**What kind of change does this PR introduce?** (check at least one)
18+
<!--
19+
If changing the UI in any way, please provide the a **before/after** screenshot:
20+
-->
1021

11-
- [ ] Bugfix
12-
- [ ] Feature
13-
- [ ] Code style update
14-
- [ ] Refactor
15-
- [ ] Docs
16-
- [ ] Build-related changes
17-
- [ ] Repo settings
18-
- [ ] Other, please describe:
22+
## **What kind of change does this PR introduce?**
1923

20-
If changing the UI of default theme, please provide the **before/after** screenshot:
24+
<!--
25+
Copy/paste one of the following options:
26+
-->
2127

22-
**Does this PR introduce a breaking change?** (check one)
28+
<!--
29+
Bugfix
30+
Feature
31+
Code style update
32+
Refactor
33+
Docs
34+
Build-related changes
35+
Repo settings
36+
Other
37+
-->
38+
39+
<!--
40+
If you chose Other, please describe.
41+
-->
42+
43+
## **For any code change,**
44+
45+
- [ ] Related documentation has been updated if needed
46+
- [ ] Related tests have been updated or tests have been added
47+
48+
## **Does this PR introduce a breaking change?** (check one)
2349

2450
- [ ] Yes
2551
- [ ] No
2652

2753
If yes, please describe the impact and migration path for existing applications:
2854

29-
**The PR fulfills these requirements:**
55+
## **Related issue, if any:**
3056

31-
- [ ] When resolving a specific issue, it's referenced in the PR's title (e.g. `fix #xxx[,#xxx]`, where "xxx" is the issue number)
57+
<!-- Paste issue's link or number hashtag here. -->
3258

33-
You have tested in the following browsers: (Providing a detailed version will be better.)
59+
## **Tested in the following browsers:**
3460

3561
- [ ] Chrome
3662
- [ ] Firefox
3763
- [ ] Safari
3864
- [ ] Edge
3965
- [ ] IE
40-
41-
If adding a **new feature**, the PR's description includes:
42-
43-
- [ ] A convincing reason for adding this feature
44-
- [ ] Related documents have been updated
45-
- [ ] Related tests have been updated
46-
47-
To avoid wasting your time, it's best to open a **feature request issue** first and wait for approval before working on it.

.github/workflows/test.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ jobs:
3131
run: npm run test:unit -- -ci --runInBand
3232
- name: integration tests
3333
run: npm run test:integration -- -ci --runInBand
34-
- uses: microsoft/playwright-github-action@v1.3.0
34+
- uses: microsoft/playwright-github-action@v1
3535
- name: e2e tests
3636
run: npm run test:e2e -- --ci --runInBand
3737
- name: Upload artifacts (diff output)

docs/deploy.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -88,11 +88,11 @@ When using the HTML5 router, you need to set up redirect rules that redirect all
8888
/* /index.html 200
8989
```
9090

91-
## ZEIT Now
91+
## Vercel
9292

93-
1. Install [Now CLI](https://zeit.co/download), `npm i -g now`
93+
1. Install [Vercel CLI](https://vercel.com/download), `npm i -g vercel`
9494
2. Change directory to your docsify website, for example `cd docs`
95-
3. Deploy with a single command, `now`
95+
3. Deploy with a single command, `vercel`
9696

9797
## AWS Amplify
9898

docs/embed-files.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,11 @@ Example:
7373

7474
If you embed the file as `iframe`, `audio` and `video`, then you may need to set the attributes of these tags.
7575

76+
?> Note, for the `audio` and `video` types, docsify adds the `controls` attribute by default. When you want add more attributes, the `controls` attribute need to be added manually if need be.
77+
```md
78+
[filename](_media/example.mp4 ':include :type=video controls width=100%')
79+
```
80+
7681
```markdown
7782
[cinwell website](https://cinwell.com ':include :type=iframe width=100% height=400px')
7883
```

docs/index.html

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,6 +111,7 @@
111111
'/zh-cn/': '搜索',
112112
'/': 'Search',
113113
},
114+
pathNamespaces: ['/es', '/de-de', '/ru-ru', '/zh-cn']
114115
},
115116
vueComponents: {
116117
'button-counter': {
@@ -179,7 +180,7 @@
179180
.replace('@master', '/blob/master');
180181
} else {
181182
url =
182-
'https://github.com/docsifyjs/docsify/blob/master/docs/' +
183+
'https://github.com/docsifyjs/docsify/blob/develop/docs/' +
183184
vm.route.file;
184185
}
185186
var editHtml = '[:memo: Edit Document](' + url + ')\n';

docs/plugins.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -187,6 +187,8 @@ Pagination for docsify. By [@imyelo](https://github.com/imyelo)
187187
<script src="//cdn.jsdelivr.net/npm/docsify-pagination/dist/docsify-pagination.min.js"></script>
188188
```
189189

190+
Click [here](https://github.com/imyelo/docsify-pagination#readme) to get more information.
191+
190192
## Tabs
191193

192194
A docsify.js plugin for displaying tabbed content from markdown.

index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@
9191
.replace('@master', '/blob/master');
9292
} else {
9393
url =
94-
'https://github.com/docsifyjs/docsify/blob/master/docs/' +
94+
'https://github.com/docsifyjs/docsify/blob/develop/docs/' +
9595
vm.route.file;
9696
}
9797
var editHtml = '[:memo: Edit Document](' + url + ')\n';

0 commit comments

Comments
 (0)