Skip to content

Commit 11e5020

Browse files
authored
Merge branch 'develop' into fix/compiler
2 parents 7dcf28b + 47cd3b6 commit 11e5020

22 files changed

+694
-565
lines changed

Diff for: SECURITY.md

+23
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: [email protected] 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.

Diff for: docs/configuration.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -301,8 +301,8 @@ window.$docsify = {
301301

302302
// For each route
303303
nameLink: {
304-
'/zh-cn/': '/zh-cn/',
305-
'/': '/',
304+
'/zh-cn/': '#/zh-cn/',
305+
'/': '#/',
306306
},
307307
};
308308
```
@@ -508,9 +508,9 @@ window.$docsify = {
508508

509509
## noCompileLinks
510510

511-
- type: `Array`
511+
- type: `Array<string>`
512512

513-
Sometimes we do not want docsify to handle our links. See [#203](https://github.com/docsifyjs/docsify/issues/203)
513+
Sometimes we do not want docsify to handle our links. See [#203](https://github.com/docsifyjs/docsify/issues/203). We can skip compiling of certain links by specifying an array of strings. Each string is converted into to a regular expression (`RegExp`) and the _whole_ href of a link is matched against it.
514514

515515
```js
516516
window.$docsify = {

Diff for: docs/index.html

+7
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,13 @@
9595
id: 6,
9696
},
9797
name: 'docsify',
98+
nameLink: {
99+
'/es/': '#/es/',
100+
'/de-de/': '#/de-de/',
101+
'/ru-ru/': '#/ru-ru/',
102+
'/zh-cn/': '#/zh-cn/',
103+
'/': '#/',
104+
},
98105
search: {
99106
noData: {
100107
'/es/': '¡No hay resultados!',

Diff for: docs/language-highlight.md

+10
Original file line numberDiff line numberDiff line change
@@ -51,3 +51,13 @@ function getAdder(int $x): int
5151
return 123;
5252
}
5353
```
54+
55+
## Highlighting Dynamic Content
56+
Code blocks [dynamically created from javascript](https://docsify.js.org/#/configuration?id=executescript) can be highlighted using the method `Prism.highlightElement` like so:
57+
58+
```javascript
59+
var code = document.createElement("code");
60+
code.innerHTML = "console.log('Hello World!')";
61+
code.setAttribute("class", "lang-javascript");
62+
Prism.highlightElement(code);
63+
```

Diff for: docs/write-a-plugin.md

+2
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,8 @@ window.$docsify = {
7575

7676
```js
7777
window.$docsify = {
78+
// The date template pattern
79+
formatUpdated: '{YYYY}/{MM}/{DD} {HH}:{mm}',
7880
plugins: [
7981
function(hook, vm) {
8082
hook.beforeEach(function(html) {

Diff for: index.html

+7
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,13 @@
5959
maxLevel: 4,
6060
subMaxLevel: 2,
6161
name: 'docsify',
62+
nameLink: {
63+
'/es/': '#/es/',
64+
'/de-de/': '#/de-de/',
65+
'/ru-ru/': '#/ru-ru/',
66+
'/zh-cn/': '#/zh-cn/',
67+
'/': '#/',
68+
},
6269
search: {
6370
noData: {
6471
'/es/': '¡No hay resultados!',

Diff for: package-lock.json

+69-61
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Diff for: package.json

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

Diff for: packages/docsify-server-renderer/package-lock.json

+31-9
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Diff for: packages/docsify-server-renderer/package.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@
1717
"dependencies": {
1818
"debug": "^4.3.2",
1919
"docsify": "^4.12.1",
20-
"dompurify": "^2.2.7",
21-
"node-fetch": "^2.6.0",
20+
"dompurify": "^2.3.2",
21+
"node-fetch": "^2.6.6",
2222
"resolve-pathname": "^3.0.0"
2323
}
2424
}

0 commit comments

Comments
 (0)