Skip to content

Commit 70c84aa

Browse files
trusktrtrusktr
authored
Merge branch 'develop' into develop
2 parents 9095a99 + cefe3f8 commit 70c84aa

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

53 files changed

+1026
-518
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ about: Create a report to help us improve
77
<!-- Please use English language -->
88
<!-- Before creating an issue please make sure you are using the latest version of Docsify. -->
99
<!-- Please ask questions on StackOverflow: https://stackoverflow.com/questions/ask?tags=docsify -->
10-
<!-- Please ask questions on gitter: https://gitter.im/docsifyjs/Lobby -->
10+
<!-- Please ask questions on Discord: https://discord.gg/3NwKFyR -->
1111

1212
## Bug Report
1313

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

‎CHANGELOG.md

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,73 @@
1+
## [4.12.1](https://github.com/docsifyjs/docsify/compare/v4.12.0...v4.12.1) (2021-03-07)
2+
3+
4+
### Bug Fixes
5+
6+
* isExternal check with malformed URL + tests ([#1510](https://github.com/docsifyjs/docsify/issues/1510)) ([ff2a66f](https://github.com/docsifyjs/docsify/commit/ff2a66f12752471277fe81a64ad6c4b2c08111fe)), closes [#1477](https://github.com/docsifyjs/docsify/issues/1477) [#1126](https://github.com/docsifyjs/docsify/issues/1126) [#1489](https://github.com/docsifyjs/docsify/issues/1489)
7+
* Replace ES6 usage for IE11 compatibility ([#1500](https://github.com/docsifyjs/docsify/issues/1500)) ([a0f61b2](https://github.com/docsifyjs/docsify/commit/a0f61b2af72cb888ea5b635021a5c9da6beb7ac5))
8+
* theme switcher in IE11 ([#1502](https://github.com/docsifyjs/docsify/issues/1502)) ([8cda078](https://github.com/docsifyjs/docsify/commit/8cda07891afeb1ea6e198d2a600f205357ab4b89))
9+
* Upgrade docsify from 4.11.6 to 4.12.0 ([#1518](https://github.com/docsifyjs/docsify/issues/1518)) ([47cd86c](https://github.com/docsifyjs/docsify/commit/47cd86c8f196a241fc23720e3addfe95d4c973cd))
10+
11+
12+
### Features
13+
14+
* Support search when there is no title ([#1519](https://github.com/docsifyjs/docsify/issues/1519)) ([bc37268](https://github.com/docsifyjs/docsify/commit/bc3726853fb2d1f9241927ea0317970ab0c8a2f2))
15+
16+
17+
### Chore
18+
19+
- Fix missing carbon ([#1501](https://github.com/docsifyjs/docsify/issues/1501))
20+
- Change Gitter to Discord throughout project ([#1507](https://github.com/docsifyjs/docsify/issues/1507))
21+
- Add test cases on isExternal ([#1515](https://github.com/docsifyjs/docsify/issues/1515))
22+
23+
24+
# [4.12.0](https://github.com/docsifyjs/docsify/compare/v4.11.6...v4.12.0) (2021-02-08)
25+
26+
27+
### Bug Fixes
28+
29+
* add missing argument for highlighting code ([#1365](https://github.com/docsifyjs/docsify/issues/1365)) ([f35bf99](https://github.com/docsifyjs/docsify/commit/f35bf99d9c762774e328b30347707e62eb8e6f63))
30+
* Can't search homepage content ([#1391](https://github.com/docsifyjs/docsify/issues/1391)) ([25bc9b7](https://github.com/docsifyjs/docsify/commit/25bc9b7eb7e878a6a50ed5f91d33d6a75f9811b0))
31+
* Cannot read property 'startsWith' of undefined ([#1358](https://github.com/docsifyjs/docsify/issues/1358)) ([9351729](https://github.com/docsifyjs/docsify/commit/9351729634b52db0e7e241bed7784fbcd5c39fe0))
32+
* Cannot read property level of undefined ([#1357](https://github.com/docsifyjs/docsify/issues/1357)) ([4807e58](https://github.com/docsifyjs/docsify/commit/4807e58cb994de83f063cb82d2b4a695f29378c8))
33+
* cannot search list content ([#1361](https://github.com/docsifyjs/docsify/issues/1361)) ([8d17dcb](https://github.com/docsifyjs/docsify/commit/8d17dcbe68048d654e62adb01a3925e39a8e0c44))
34+
* duplicate search content when `/README` or `/` exists in the sidebar ([#1403](https://github.com/docsifyjs/docsify/issues/1403)) ([7c3bf98](https://github.com/docsifyjs/docsify/commit/7c3bf98df869188d5956ed1a331f7048b6eba441))
35+
* package.json & package-lock.json to reduce vulnerabilities ([#1419](https://github.com/docsifyjs/docsify/issues/1419)) ([69b6907](https://github.com/docsifyjs/docsify/commit/69b6907c864dbcdf1fe5c75f51a80e6ae6ec279d))
36+
* packages/docsify-server-renderer/package.json & packages/docsify-server-renderer/package-lock.json to reduce vulnerabilities ([#1389](https://github.com/docsifyjs/docsify/issues/1389)) ([62cd35e](https://github.com/docsifyjs/docsify/commit/62cd35ee8345270aab7a48bc761db007d54a0f48))
37+
* packages/docsify-server-renderer/package.json & packages/docsify-server-renderer/package-lock.json to reduce vulnerabilities ([#1418](https://github.com/docsifyjs/docsify/issues/1418)) ([58fbca0](https://github.com/docsifyjs/docsify/commit/58fbca00ebd12f636c213d386761df9ebfb2bd4c))
38+
* Prevent loading remote content via URL hash ([#1489](https://github.com/docsifyjs/docsify/issues/1489)) ([14ce7f3](https://github.com/docsifyjs/docsify/commit/14ce7f3d862ac79fc7d9d316cb2e057d50e1b506)), closes [#1477](https://github.com/docsifyjs/docsify/issues/1477) [#1126](https://github.com/docsifyjs/docsify/issues/1126)
39+
* search on homepage test ([#1398](https://github.com/docsifyjs/docsify/issues/1398)) ([ee550d0](https://github.com/docsifyjs/docsify/commit/ee550d0c51f222851854c7cd7e9e6f76e26eb6f4))
40+
* search titles containing ignored characters ([#1395](https://github.com/docsifyjs/docsify/issues/1395)) ([a2ebb21](https://github.com/docsifyjs/docsify/commit/a2ebb2192ac73211a8924111d736df9574abf61b))
41+
* sidebar active class and expand don't work as expect when use "space" in markdown filename ([#1454](https://github.com/docsifyjs/docsify/issues/1454)) ([dcf5a64](https://github.com/docsifyjs/docsify/commit/dcf5a644eb6a2eef65fb940f3407c12828a679bc)), closes [#1032](https://github.com/docsifyjs/docsify/issues/1032)
42+
* sidebar horizontal scroll bar ([#1362](https://github.com/docsifyjs/docsify/issues/1362)) ([b480822](https://github.com/docsifyjs/docsify/commit/b480822286c66b478e5a7a9b2c82a10b99c69121))
43+
* sidebar title error ([#1360](https://github.com/docsifyjs/docsify/issues/1360)) ([2100fc3](https://github.com/docsifyjs/docsify/commit/2100fc318b009c6e448e48ffff6a693f1988916c))
44+
* slugs are still broken when headings contain html ([#1443](https://github.com/docsifyjs/docsify/issues/1443)) ([76c5e68](https://github.com/docsifyjs/docsify/commit/76c5e685d75ee6df9acc0a7cf92d5daa138c3240))
45+
* the sidebar links to another site. ([#1336](https://github.com/docsifyjs/docsify/issues/1336)) ([c9d4f7a](https://github.com/docsifyjs/docsify/commit/c9d4f7abc94a2cbc4bb558013775df380c1c8376))
46+
* title error when sidebar link exists with html tag ([#1404](https://github.com/docsifyjs/docsify/issues/1404)) ([8ccc202](https://github.com/docsifyjs/docsify/commit/8ccc20225104376af2e5df6757c4dbd58c0e758e)), closes [#1408](https://github.com/docsifyjs/docsify/issues/1408)
47+
* Unable to navigate on server without default index support ([#1372](https://github.com/docsifyjs/docsify/issues/1372)) ([759ffac](https://github.com/docsifyjs/docsify/commit/759ffac992b19dbb05b92114ec5620d3bb180d0d))
48+
* upgrade debug from 4.1.1 to 4.3.0 ([#1390](https://github.com/docsifyjs/docsify/issues/1390)) ([ae45b32](https://github.com/docsifyjs/docsify/commit/ae45b3201ba03303a2feb5a347b18fda818a569a))
49+
* upgrade debug from 4.3.0 to 4.3.1 ([#1446](https://github.com/docsifyjs/docsify/issues/1446)) ([bc3350f](https://github.com/docsifyjs/docsify/commit/bc3350f6e6bfe670c95569b4e9c51321f5c7dbb9))
50+
* upgrade debug from 4.3.1 to 4.3.2 ([#1463](https://github.com/docsifyjs/docsify/issues/1463)) ([df21153](https://github.com/docsifyjs/docsify/commit/df21153ab5e841ad89707e07c68a04873a2f3fe8))
51+
* upgrade docsify from 4.11.4 to 4.11.6 ([#1373](https://github.com/docsifyjs/docsify/issues/1373)) ([c2d12ed](https://github.com/docsifyjs/docsify/commit/c2d12ed27fe86b0c5cd690b4d8a22bf06d2a90b9))
52+
* upgrade dompurify from 2.0.17 to 2.1.0 ([#1397](https://github.com/docsifyjs/docsify/issues/1397)) ([1863d8e](https://github.com/docsifyjs/docsify/commit/1863d8edb70da234bf7f211986ba71706351682f))
53+
* upgrade dompurify from 2.1.0 to 2.1.1 ([#1402](https://github.com/docsifyjs/docsify/issues/1402)) ([8cf9fd8](https://github.com/docsifyjs/docsify/commit/8cf9fd8150bd67709c68d8dfe4dc881624583ac8))
54+
* upgrade dompurify from 2.2.2 to 2.2.3 ([#1457](https://github.com/docsifyjs/docsify/issues/1457)) ([720d909](https://github.com/docsifyjs/docsify/commit/720d9091c8e571d6c891426983f54d9c94739182))
55+
* upgrade dompurify from 2.2.2 to 2.2.6 ([#1483](https://github.com/docsifyjs/docsify/issues/1483)) ([eee9507](https://github.com/docsifyjs/docsify/commit/eee9507d435459ae8e68e1112bb58a63b2f58530))
56+
* upgrade dompurify from 2.2.3 to 2.2.6 ([#1482](https://github.com/docsifyjs/docsify/issues/1482)) ([7adad57](https://github.com/docsifyjs/docsify/commit/7adad57df1b7efa469b0cde37f788c36dc27cf8b))
57+
* upgrade marked from 1.2.4 to 1.2.9 ([#1486](https://github.com/docsifyjs/docsify/issues/1486)) ([716a7fa](https://github.com/docsifyjs/docsify/commit/716a7fa777a1eee66964977e1d4405cff3275c53))
58+
* upgrade prismjs from 1.21.0 to 1.22.0 ([#1415](https://github.com/docsifyjs/docsify/issues/1415)) ([0806f48](https://github.com/docsifyjs/docsify/commit/0806f48531b6cb5e6a395c12ab88f0b59281bbf8))
59+
* upgrade prismjs from 1.22.0 to 1.23.0 ([#1481](https://github.com/docsifyjs/docsify/issues/1481)) ([5f29cde](https://github.com/docsifyjs/docsify/commit/5f29cde84c7b74d70c34e3f1f43c479f1bba670d))
60+
* Use legacy-compatible methods for IE11 ([#1495](https://github.com/docsifyjs/docsify/issues/1495)) ([06cbebf](https://github.com/docsifyjs/docsify/commit/06cbebfc0d34726f4a7102a7dc9020520f3a7f86))
61+
62+
63+
### Features
64+
65+
* search ignore diacritical marks ([#1434](https://github.com/docsifyjs/docsify/issues/1434)) ([8968a74](https://github.com/docsifyjs/docsify/commit/8968a744cea5910057ba59ef690316722a35b341))
66+
* Add Jest + Playwright Testing ([#1276](https://github.com/docsifyjs/docsify/issues/1276))
67+
* Add Vue components, mount options, global options, and v3 support ([#1409](https://github.com/docsifyjs/docsify/issues/1409))
68+
69+
70+
171
## [4.11.6](https://github.com/docsifyjs/docsify/compare/v4.11.5...v4.11.6) (2020-08-22)
272

373

‎README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
<a><img src="https://github.com/docsifyjs/docsify/workflows/Testing%20the%20e2e%20test%20suites/badge.svg?branch=develop&amp;event=push" alt="Testing the e2e test suites"></a>
1818
<a href="https://www.npmjs.com/package/docsify"><img alt="npm" src="https://img.shields.io/npm/v/docsify.svg?style=flat-square"></a>
1919
<a href="https://github.com/QingWei-Li/donate"><img alt="donate" src="https://img.shields.io/badge/%24-donate-ff69b4.svg?style=flat-square"></a>
20-
<a href="https://gitter.im/docsifyjs/Lobby?utm_source=share-link&utm_medium=link&utm_campaign=share-link"><img alt="gitter" src="https://img.shields.io/gitter/room/docsifyjs/docsify.svg?style=flat-square"></a>
20+
<a href="https://discord.gg/3NwKFyR"><img alt="Join Discord community and chat about Docsify" src="https://img.shields.io/discord/713647066802421792.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2&cacheSeconds=60"></a>
2121
<a href="https://gitpod.io/#https://github.com/docsifyjs/docsify"><img src="https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod" alt="Gitpod Ready-to-Code"></a>
2222
</p>
2323

@@ -36,7 +36,7 @@
3636
- [CLI](https://github.com/docsifyjs/docsify-cli)
3737
- CDN: [UNPKG](https://unpkg.com/docsify/) | [jsDelivr](https://cdn.jsdelivr.net/npm/docsify/) | [cdnjs](https://cdnjs.com/libraries/docsify)
3838
- [Awesome docsify](https://github.com/docsifyjs/awesome-docsify)
39-
- [Community chat](https://gitter.im/docsifyjs/Lobby)
39+
- [Community chat](https://discord.gg/3NwKFyR)
4040

4141
## Features
4242

‎SECURITY.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Security Policy
2+
3+
If you believe you have found a security vulnerability in docsify, please report it to us asap.
4+
5+
## Reporting a Vulnerability
6+
7+
**Please do not report security vulnerabilities through our public GitHub issues.**
8+
9+
Send email via :email: maintainers@docsifyjs.org to us.
10+
11+
Please include as much of the following information as possible to help us better understand the possible issue:
12+
13+
- Type of issue (e.g. cross-site scripting)
14+
- Full paths of source file(s) related to the manifestation of the issue
15+
- The location of the affected source code (tag/branch/commit or direct URL)
16+
- Any special configuration required to reproduce the issue
17+
- Step-by-step instructions to reproduce the issue
18+
- Proof-of-concept or exploit code
19+
- Impact of the issue, including how an attacker might exploit the issue
20+
21+
This information will help us triage your report more quickly.
22+
23+
Thank you in advance.

‎docs/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,10 +29,10 @@ Please consider donating if you think docsify is helpful to you or that my work
2929

3030
## Community
3131

32-
Users and the development team are usually in the [Gitter chat room](https://gitter.im/docsifyjs/Lobby).
32+
Users and the development team are usually in the [Discord server](https://discord.gg/3NwKFyR).
3333

3434
## Special Thanks
3535

3636
_Vercel_ has given us a Pro account.
3737

38-
<a href="https://vercel.com/?utm_source=docsifyjsdocs" target="_blank"><img src="_media/vercel_logo.svg" width="100px"></a>
38+
<a href="https://vercel.com/?utm_source=docsifyjsdocs" target="_blank"><img src="https://cdn.jsdelivr.net/gh/docsifyjs/docsify/docs/_media/vercel_logo.svg" width="100px"></a>

‎docs/_coverpage.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
![logo](_media/icon.svg)
22

3-
# docsify <small>4.11.6</small>
3+
# docsify <small>4.12.1</small>
44

55
> A magical documentation site generator.
66

‎docs/_navbar.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,5 @@
22
- [:uk: English](/)
33
- [:cn: 中文](/zh-cn/)
44
- [:de: Deutsch](/de-de/)
5-
- [:es: Spanish](/es/)
6-
- [:ru: Russian](/ru-ru/)
5+
- [:es: Español](/es/)
6+
- [:ru: Русский](/ru-ru/)

‎docs/_sidebar.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@
2020
- [Helpers](helpers.md)
2121
- [Vue compatibility](vue.md)
2222
- [CDN](cdn.md)
23-
- [Offline Mode(PWA)](pwa.md)
24-
- [Server-Side Rendering(SSR)](ssr.md)
23+
- [Offline Mode (PWA)](pwa.md)
24+
- [Server-Side Rendering (SSR)](ssr.md)
2525
- [Embed Files](embed-files.md)
2626

2727
- [Awesome docsify](awesome.md)

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy