From d4c9247b87c0a2701683ed1a17383cfb451cf609 Mon Sep 17 00:00:00 2001 From: Joe Pea Date: Wed, 15 Jul 2020 23:00:28 -0700 Subject: [PATCH 01/28] fix: gitignore was ignoring folders in src, so VS Code search results or file fuzzy finder were not working, etc --- .gitignore | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/.gitignore b/.gitignore index e9803a96f..dc015fd2a 100644 --- a/.gitignore +++ b/.gitignore @@ -2,10 +2,10 @@ .DS_Store .idea node_modules -themes/ -lib/ -cypress/integration/examples -cypress/fixtures/docs +/themes/ +/lib/ +/cypress/integration/examples +/cypress/fixtures/docs # exceptions -!.gitkeep \ No newline at end of file +!.gitkeep From e664a3428337eaeedd32dcc4b534748c0f0c7143 Mon Sep 17 00:00:00 2001 From: Joe Pea Date: Wed, 15 Jul 2020 23:20:10 -0700 Subject: [PATCH 02/28] remove `lib` from pull request template as it is gitignored --- .github/PULL_REQUEST_TEMPLATE.md | 9 +-------- 1 file changed, 1 insertion(+), 8 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index bb31bd41f..2d5b3e545 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -14,6 +14,7 @@ - [ ] Refactor - [ ] Docs - [ ] Build-related changes +- [ ] Repo settings - [ ] Other, please describe: If changing the UI of default theme, please provide the **before/after** screenshot: @@ -44,11 +45,3 @@ If adding a **new feature**, the PR's description includes: - [ ] Related tests have been updated To avoid wasting your time, it's best to open a **feature request issue** first and wait for approval before working on it. - - -**Other information:** - ---- - -* [ ] DO NOT include files inside `lib` directory. - From 667496b85d99b168255f58e60a6bfe902cc6ee03 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E6=B2=88=E5=94=81?= <52o@qq52o.cn> Date: Sun, 19 Jul 2020 09:00:23 +0800 Subject: [PATCH 03/28] feat: Add title to sidebar links (#1286) --- src/core/event/sidebar.js | 2 ++ src/core/render/tpl.js | 2 +- 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/src/core/event/sidebar.js b/src/core/event/sidebar.js index b15cb2afe..7ca72d94c 100644 --- a/src/core/event/sidebar.js +++ b/src/core/event/sidebar.js @@ -86,6 +86,8 @@ export function getAndActive(router, el, isParent, autoTitle) { const href = a.getAttribute('href'); const node = isParent ? a.parentNode : a; + a.title = a.innerText; + if (hash.indexOf(href) === 0 && !target) { target = a; dom.toggleClass(node, 'add', 'active'); diff --git a/src/core/render/tpl.js b/src/core/render/tpl.js index e3b35a5c3..2bad3a311 100644 --- a/src/core/render/tpl.js +++ b/src/core/render/tpl.js @@ -91,7 +91,7 @@ export function tree(toc, tpl = '') { let innerHTML = ''; toc.forEach(node => { - innerHTML += `
  • ${node.title}
  • `; + innerHTML += `
  • ${node.title}
  • `; if (node.children) { innerHTML += tree(node.children, tpl); } From 6f9baab616b7c608866582165792d5abf3c40330 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E6=B2=88=E5=94=81?= <52o@qq52o.cn> Date: Mon, 20 Jul 2020 08:54:54 +0800 Subject: [PATCH 04/28] style: Update index.html and scroll.js (#1292) --- docs/index.html | 1 - index.html | 10 +++++----- src/core/event/scroll.js | 7 +++++-- 3 files changed, 10 insertions(+), 8 deletions(-) diff --git a/docs/index.html b/docs/index.html index 3f518db13..766d1acd8 100644 --- a/docs/index.html +++ b/docs/index.html @@ -62,7 +62,6 @@ '/': 'Search' } }, - formatUpdated: '{MM}/{DD} {HH}:{mm}', plugins: [ function (hook, vm) { hook.beforeEach(function (html) { diff --git a/index.html b/index.html index 5d2319844..9c950964d 100644 --- a/index.html +++ b/index.html @@ -9,6 +9,7 @@ + @@ -64,6 +68,7 @@ } }, plugins: [ + DocsifyCarbon.create('CEBI6KQE', 'docsifyjsorg'), function (hook, vm) { hook.beforeEach(function (html) { if (/githubusercontent\.com/.test(vm.route.file)) { diff --git a/index.html b/index.html index 9f443671b..8247ce5f5 100644 --- a/index.html +++ b/index.html @@ -10,10 +10,15 @@ + @@ -56,6 +61,7 @@ pathNamespaces: ['/zh-cn', '/de-de', '/ru-ru', '/es'] }, plugins: [ + DocsifyCarbon.create('CEBI6KQE', 'docsifyjsorg'), function (hook, vm) { hook.beforeEach(function (html) { if (/githubusercontent\.com/.test(vm.route.file)) { From 59d090fe9096bc03e259c166634bb75bb2623f85 Mon Sep 17 00:00:00 2001 From: Snyk bot Date: Tue, 18 Aug 2020 17:04:44 +0300 Subject: [PATCH 23/28] fix: upgrade tinydate from 1.2.0 to 1.3.0 (#1341) Snyk has created this PR to upgrade tinydate from 1.2.0 to 1.3.0. See this package in npm: https://www.npmjs.com/package/tinydate See this project in Snyk: https://app.snyk.io/org/anikethsaha/project/836f877b-b98e-47ed-89fc-554e9b2e146d?utm_source=github&utm_medium=upgrade-pr --- package-lock.json | 6 +++--- package.json | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/package-lock.json b/package-lock.json index b681513ad..3189abd57 100644 --- a/package-lock.json +++ b/package-lock.json @@ -13950,9 +13950,9 @@ "optional": true }, "tinydate": { - "version": "1.2.0", - "resolved": "https://registry.npmjs.org/tinydate/-/tinydate-1.2.0.tgz", - "integrity": "sha512-3GwPk8VhDFnUZ2TrgkhXJs6hcMAIIw4x/xkz+ayK6dGoQmp2nUwKzBXK0WnMsqkh6vfUhpqQicQF3rbshfyJkg==" + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/tinydate/-/tinydate-1.3.0.tgz", + "integrity": "sha512-7cR8rLy2QhYHpsBDBVYnnWXm8uRTr38RoZakFSW7Bs7PzfMPNZthuMLkwqZv7MTu8lhQ91cOFYS5a7iFj2oR3w==" }, "tmp": { "version": "0.0.33", diff --git a/package.json b/package.json index 4894b7fd8..7b16404f2 100644 --- a/package.json +++ b/package.json @@ -63,7 +63,7 @@ "opencollective-postinstall": "^2.0.2", "prismjs": "^1.19.0", "strip-indent": "^3.0.0", - "tinydate": "^1.0.0", + "tinydate": "^1.3.0", "tweezer.js": "^1.4.0" }, "devDependencies": { From 5037f0b4e63051f179fc9dfe7b0aa602e7135e28 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E6=B2=88=E5=94=81?= <52o@qq52o.cn> Date: Thu, 20 Aug 2020 14:06:45 +0800 Subject: [PATCH 24/28] chore: Remove the src directory from packages.json's files (#1344) --- package.json | 1 - 1 file changed, 1 deletion(-) diff --git a/package.json b/package.json index 7b16404f2..a13f83b1e 100644 --- a/package.json +++ b/package.json @@ -17,7 +17,6 @@ "unpkg": "lib/docsify.min.js", "files": [ "lib", - "src", "themes" ], "scripts": { From 1dc754a08bac7b9bf46d2c872160f161ef3ea9cb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E6=B2=88=E5=94=81?= <52o@qq52o.cn> Date: Fri, 21 Aug 2020 10:42:31 +0800 Subject: [PATCH 25/28] fix typo (#1345) --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index bdd2fa558..0d44dec32 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@

    - docsify + docsify

    From d439bac93f479d0480799880538fc3104e54c907 Mon Sep 17 00:00:00 2001 From: Snyk bot Date: Fri, 21 Aug 2020 10:48:15 +0300 Subject: [PATCH 26/28] fix: packages/docsify-server-renderer/package.json & packages/docsify-server-renderer/package-lock.json to reduce vulnerabilities (#1250) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The following vulnerabilities are fixed with an upgrade: - https://snyk.io/vuln/SNYK-JS-DOCSIFY-567099 Co-authored-by: 沈唁 <52o@qq52o.cn> --- .../docsify-server-renderer/package-lock.json | 19 ++++++++++--------- packages/docsify-server-renderer/package.json | 2 +- 2 files changed, 11 insertions(+), 10 deletions(-) diff --git a/packages/docsify-server-renderer/package-lock.json b/packages/docsify-server-renderer/package-lock.json index f9e48117f..bfd9a035f 100644 --- a/packages/docsify-server-renderer/package-lock.json +++ b/packages/docsify-server-renderer/package-lock.json @@ -30,10 +30,11 @@ "optional": true }, "docsify": { - "version": "4.11.2", - "resolved": "https://registry.npmjs.org/docsify/-/docsify-4.11.2.tgz", - "integrity": "sha512-vQVg+ERdYgrlgLcwTX9FdjUn3xb7PSwaiYopIAmCLraHJCr1e0r8Uzi2vm6XEwTrSrdd6C5j3Eg+QctsOGA4Gg==", + "version": "4.11.4", + "resolved": "https://registry.npmjs.org/docsify/-/docsify-4.11.4.tgz", + "integrity": "sha512-Qwt98y6ddM2Wb46gRH/zQpEAvw70AlIpzVlB9Wi2u2T2REg9O+bXMpJ27F5TaRTn2bD6SF1VyZYNUfimpihZwQ==", "requires": { + "dompurify": "^2.0.8", "marked": "^0.7.0", "medium-zoom": "^1.0.5", "opencollective-postinstall": "^2.0.2", @@ -68,9 +69,9 @@ "integrity": "sha512-aLGa6WlTuFKWvH88bqTrY5ztJMN+D0hd8UX6BYc4YSoPayppzETjZUcdVcksgaoQEMg4cZSmXPg846fTp2rjRQ==" }, "min-indent": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/min-indent/-/min-indent-1.0.0.tgz", - "integrity": "sha1-z8RcN+nsDY8KDsPdTvf3w6vjklY=" + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/min-indent/-/min-indent-1.0.1.tgz", + "integrity": "sha512-I9jwMn07Sy/IwOj3zVkVik2JTvgpaykDZEigL6Rx6N9LbMywwUSMtxET+7lVoDLLd3O3IXwJwvuuns8UB/HeAg==" }, "ms": { "version": "2.1.2", @@ -83,9 +84,9 @@ "integrity": "sha512-8dG4H5ujfvFiqDmVu9fQ5bOHUC15JMjMY/Zumv26oOvvVJjM67KF8koCWIabKQ1GJIa9r2mMZscBq/TbdOcmNA==" }, "opencollective-postinstall": { - "version": "2.0.2", - "resolved": "https://registry.npmjs.org/opencollective-postinstall/-/opencollective-postinstall-2.0.2.tgz", - "integrity": "sha512-pVOEP16TrAO2/fjej1IdOyupJY8KDUM1CvsaScRbw6oddvpQoOfGk4ywha0HKKVAD6RkW4x6Q+tNBwhf3Bgpuw==" + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/opencollective-postinstall/-/opencollective-postinstall-2.0.3.tgz", + "integrity": "sha512-8AV/sCtuzUeTo8gQK5qDZzARrulB3egtLzFgteqB2tcT4Mw7B8Kt7JcDHmltjz6FOAHsvTevk70gZEbhM4ZS9Q==" }, "prismjs": { "version": "1.21.0", diff --git a/packages/docsify-server-renderer/package.json b/packages/docsify-server-renderer/package.json index d11ee6817..7c3686774 100644 --- a/packages/docsify-server-renderer/package.json +++ b/packages/docsify-server-renderer/package.json @@ -16,7 +16,7 @@ }, "dependencies": { "debug": "^4.1.1", - "docsify": "^4.11.2", + "docsify": "^4.11.4", "dompurify": "^2.0.8", "node-fetch": "^2.6.0", "resolve-pathname": "^3.0.0" From dfa5616cfc958c2c4489d50c6bd72021300ae92a Mon Sep 17 00:00:00 2001 From: sy-records <52o@qq52o.cn> Date: Fri, 21 Aug 2020 19:15:36 +0800 Subject: [PATCH 27/28] [build] 4.11.5 --- docs/_coverpage.md | 2 +- packages/docsify-server-renderer/package-lock.json | 2 +- packages/docsify-server-renderer/package.json | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/_coverpage.md b/docs/_coverpage.md index 07c318651..51db8d2e9 100644 --- a/docs/_coverpage.md +++ b/docs/_coverpage.md @@ -1,6 +1,6 @@ ![logo](_media/icon.svg) -# docsify 4.11.4 +# docsify 4.11.5 > A magical documentation site generator. diff --git a/packages/docsify-server-renderer/package-lock.json b/packages/docsify-server-renderer/package-lock.json index bfd9a035f..12811bd6b 100644 --- a/packages/docsify-server-renderer/package-lock.json +++ b/packages/docsify-server-renderer/package-lock.json @@ -1,6 +1,6 @@ { "name": "docsify-server-renderer", - "version": "4.11.4", + "version": "4.11.5", "lockfileVersion": 1, "requires": true, "dependencies": { diff --git a/packages/docsify-server-renderer/package.json b/packages/docsify-server-renderer/package.json index 7c3686774..9075a03f4 100644 --- a/packages/docsify-server-renderer/package.json +++ b/packages/docsify-server-renderer/package.json @@ -1,6 +1,6 @@ { "name": "docsify-server-renderer", - "version": "4.11.4", + "version": "4.11.5", "description": "docsify server renderer", "author": { "name": "qingwei-li", From e474ea86d4a04f9b2545aca9448356c2dc589a1a Mon Sep 17 00:00:00 2001 From: sy-records <52o@qq52o.cn> Date: Fri, 21 Aug 2020 19:15:39 +0800 Subject: [PATCH 28/28] chore: add changelog 4.11.5 --- CHANGELOG.md | 29 +++++++++++++++++++++++++++++ package-lock.json | 2 +- package.json | 2 +- 3 files changed, 31 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 784dec697..facd1fe95 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,32 @@ +## [4.11.5](https://github.com/docsifyjs/docsify/compare/v4.11.4...v4.11.5) (2020-08-21) + + +### Bug Fixes + +* Russian language link error ([#1270](https://github.com/docsifyjs/docsify/issues/1270)) ([2a52460](https://github.com/docsifyjs/docsify/commit/2a52460a59448abaf681046fbc5dca642285ae1f)) +* {docsify-updated} in the sample code is parsed into time ([#1321](https://github.com/docsifyjs/docsify/issues/1321)) ([2048610](https://github.com/docsifyjs/docsify/commit/2048610aacd4e3c6a592f4247834a726c7ca33fb)) +* Add error handling for missing dependencies (fixes [#1210](https://github.com/docsifyjs/docsify/issues/1210)) ([#1232](https://github.com/docsifyjs/docsify/issues/1232)) ([3673001](https://github.com/docsifyjs/docsify/commit/3673001a24cb24c57454f9bc7619de49d2c3a044)) +* after setting the background image, the button is obscured ([#1234](https://github.com/docsifyjs/docsify/issues/1234)) ([34d918f](https://github.com/docsifyjs/docsify/commit/34d918f9973bdb8e893248853e3ef7e803d4c253)) +* convert {docsify-ignore} and {docsify-ignore-all} to HTML comments ([#1318](https://github.com/docsifyjs/docsify/issues/1318)) ([90d283d](https://github.com/docsifyjs/docsify/commit/90d283d340502456a5d8495df596bb4a02ceb39b)) +* fallback page should use path not file location ([#1301](https://github.com/docsifyjs/docsify/issues/1301)) ([2bceabc](https://github.com/docsifyjs/docsify/commit/2bceabcb8e623570540493e2f1d956adf45c99e7)) +* Fix search error when exist translations documents ([#1300](https://github.com/docsifyjs/docsify/issues/1300)) ([b869019](https://github.com/docsifyjs/docsify/commit/b8690199006366e86084e9e018def7b9b8f46512)) +* gitignore was ignoring folders in src, so VS Code search results or file fuzzy finder were not working, etc ([d4c9247](https://github.com/docsifyjs/docsify/commit/d4c9247b87c0a2701683ed1a17383cfb451cf609)) +* packages/docsify-server-renderer/package.json & packages/docsify-server-renderer/package-lock.json to reduce vulnerabilities ([#1250](https://github.com/docsifyjs/docsify/issues/1250)) ([d439bac](https://github.com/docsifyjs/docsify/commit/d439bac93f479d0480799880538fc3104e54c907)) +* search can not search the table header ([#1256](https://github.com/docsifyjs/docsify/issues/1256)) ([3f03e78](https://github.com/docsifyjs/docsify/commit/3f03e78418993d8e9a4f5062e10dc79c3753389e)) +* Search plugin: matched text is replaced with search text ([#1298](https://github.com/docsifyjs/docsify/issues/1298)) ([78775b6](https://github.com/docsifyjs/docsify/commit/78775b6ee73102cc5ac71c0ee2b392c5f4f6f4f8)) +* the uncaught typeerror when el is null ([#1308](https://github.com/docsifyjs/docsify/issues/1308)) ([952f4c9](https://github.com/docsifyjs/docsify/commit/952f4c921b7a6a558c500ca6b105582d39ad36a2)) +* Updated docs with instructions for installing specific version (fixes [#780](https://github.com/docsifyjs/docsify/issues/780)) ([#1225](https://github.com/docsifyjs/docsify/issues/1225)) ([b90c948](https://github.com/docsifyjs/docsify/commit/b90c948090e89fa778279c95060dbd7668285658)) +* upgrade medium-zoom from 1.0.5 to 1.0.6 ([3beaa66](https://github.com/docsifyjs/docsify/commit/3beaa6666b78518f1ffaa37f6942f3cb08fef896)) +* upgrade tinydate from 1.2.0 to 1.3.0 ([#1341](https://github.com/docsifyjs/docsify/issues/1341)) ([59d090f](https://github.com/docsifyjs/docsify/commit/59d090fe9096bc03e259c166634bb75bb2623f85)) + + +### Features + +* **search:** add pathNamespaces option ([d179dde](https://github.com/docsifyjs/docsify/commit/d179dde1c71acdcbe66cb762377b123926c55bf2)) +* Add title to sidebar links ([#1286](https://github.com/docsifyjs/docsify/issues/1286)) ([667496b](https://github.com/docsifyjs/docsify/commit/667496b85d99b168255f58e60a6bfe902cc6ee03)) + + + ## [4.11.4](https://github.com/docsifyjs/docsify/compare/v4.11.3...v4.11.4) (2020-06-18) diff --git a/package-lock.json b/package-lock.json index 3189abd57..6cd171362 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,6 +1,6 @@ { "name": "docsify", - "version": "4.11.4", + "version": "4.11.5", "lockfileVersion": 1, "requires": true, "dependencies": { diff --git a/package.json b/package.json index a13f83b1e..77dc42fdc 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "docsify", - "version": "4.11.4", + "version": "4.11.5", "description": "A magical documentation generator.", "author": { "name": "qingwei-li",