Merge branch 'develop' into fix/381

Author: sy-records

Dockerfile

@@ -0,0 +1,9 @@
+FROM mcr.microsoft.com/playwright:focal
+WORKDIR /app
+COPY . .
+RUN rm package-lock.json
+RUN npm install
+RUN npx playwright install  
+RUN npm run build
+ENTRYPOINT ["npm", "run"]
+CMD ["test"]

SECURITY.md

@@ -0,0 +1,23 @@
+# Security Policy
+
+If you believe you have found a security vulnerability in docsify, please report it to us asap.
+
+## Reporting a Vulnerability
+
+**Please do not report security vulnerabilities through our public GitHub issues.**
+
+Send email via :email: maintainers@docsifyjs.org to us.  
+
+Please include as much of the following information as possible to help us better understand the possible issue:
+
+- Type of issue (e.g. cross-site scripting)
+- Full paths of source file(s) related to the manifestation of the issue
+- The location of the affected source code (tag/branch/commit or direct URL)
+- Any special configuration required to reproduce the issue
+- Step-by-step instructions to reproduce the issue
+- Proof-of-concept or exploit code
+- Impact of the issue, including how an attacker might exploit the issue
+
+This information will help us triage your report more quickly.
+
+Thank you in advance.

docs/configuration.md

@@ -301,8 +301,8 @@ window.$docsify = {
 
   // For each route
   nameLink: {
-    '/zh-cn/': '/zh-cn/',
-    '/': '/',
+    '/zh-cn/': '#/zh-cn/',
+    '/': '#/',
   },
 };
 ```
@@ -508,9 +508,9 @@ window.$docsify = {
 
 ## noCompileLinks
 
-- type: `Array`
+- type: `Array<string>`
 
-Sometimes we do not want docsify to handle our links. See [#203](https://github.com/docsifyjs/docsify/issues/203)
+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.
 
 ```js
 window.$docsify = {

docs/index.html

@@ -95,6 +95,13 @@
           id: 6,
         },
         name: 'docsify',
+        nameLink: {
+          '/es/': '#/es/',
+          '/de-de/': '#/de-de/',
+          '/ru-ru/': '#/ru-ru/',
+          '/zh-cn/': '#/zh-cn/',
+          '/': '#/',
+        },
         search: {
           noData: {
             '/es/': '¡No hay resultados!',

docs/language-highlight.md

@@ -51,3 +51,13 @@ function getAdder(int $x): int
     return 123;
 }
 ```
+
+## Highlighting Dynamic Content
+Code blocks [dynamically created from javascript](https://docsify.js.org/#/configuration?id=executescript) can be highlighted using the method `Prism.highlightElement` like so:
+
+```javascript
+var code = document.createElement("code");
+code.innerHTML = "console.log('Hello World!')";
+code.setAttribute("class", "lang-javascript");
+Prism.highlightElement(code);
+```

docs/write-a-plugin.md

@@ -75,6 +75,8 @@ window.$docsify = {
 
 ```js
 window.$docsify = {
+  // The date template pattern
+  formatUpdated: '{YYYY}/{MM}/{DD} {HH}:{mm}',
   plugins: [
     function(hook, vm) {
       hook.beforeEach(function(html) {

index.html

@@ -59,6 +59,13 @@
         maxLevel: 4,
         subMaxLevel: 2,
         name: 'docsify',
+        nameLink: {
+          '/es/': '#/es/',
+          '/de-de/': '#/de-de/',
+          '/ru-ru/': '#/ru-ru/',
+          '/zh-cn/': '#/zh-cn/',
+          '/': '#/',
+        },
         search: {
           noData: {
             '/es/': '¡No hay resultados!',

package-lock.json

@@ -28,6 +28,7 @@
     "lint": "eslint .",
     "fixlint": "eslint . --fix",
     "test": "jest",
+    "build:test": "npm run build && npm test",
     "test:e2e": "jest --selectProjects e2e",
     "test:integration": "jest --selectProjects integration",
     "test:unit": "jest --selectProjects unit",
@@ -43,7 +44,16 @@
     "prepare": "npm run build",
     "pub:next": "cross-env RELEASE_TAG=next sh build/release.sh",
     "pub": "sh build/release.sh",
-    "postinstall": "opencollective-postinstall"
+    "postinstall": "opencollective-postinstall",
+    "docker:build": "docker build -f Dockerfile -t docsify-test:local .",
+    "docker:clean": "docker rmi docsify-test:local",
+    "docker:rebuild": "npm run docker:clean && npm run docker:build",
+    "docker:test": "npm run docker:cli -- test",
+    "docker:build:test": "npm run docker:cli -- build:test",
+    "docker:test:e2e": "npm run docker:cli -- test:e2e",
+    "docker:test:integration": "npm run docker:cli -- test:integration",
+    "docker:test:unit": "npm run docker:cli -- test:unit",
+    "docker:cli": "docker run --rm -it --ipc=host --mount type=bind,source=$(pwd)/test,target=/app/test docsify-test:local"
   },
   "husky": {
     "hooks": {
@@ -54,7 +64,7 @@
     "*.js": "eslint --fix"
   },
   "dependencies": {
-    "dompurify": "^2.2.9",
+    "dompurify": "^2.3.1",
     "marked": "^1.2.9",
     "medium-zoom": "^1.0.6",
     "opencollective-postinstall": "^2.0.2",