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

.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
+!.gitkeep

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)
 
 

README.md

@@ -1,6 +1,6 @@
 <p align="center">
   <a href="https://docsify.js.org">
-    <img alt="docsify" src="https://github.com/docsifyjs/docsify/blob/develop/docs/_media/icon.svg">
+    <img alt="docsify" src="./docs/_media/icon.svg">
   </a>
 </p>
 
@@ -11,7 +11,7 @@
 <p align="center">
   <a href="#backers"><img alt="Backers on Open Collective" src="https://opencollective.com/docsify/backers/badge.svg?style=flat-square"></a>
   <a href="#sponsors">
-    <img alt="Sponsors on Open Collective" src="https://opencollective.com/docsify/sponsors/badge.svg?style=flat-square"></a> 
+    <img alt="Sponsors on Open Collective" src="https://opencollective.com/docsify/sponsors/badge.svg?style=flat-square"></a>
   <a><img src="https://github.com/docsifyjs/docsify/workflows/Unit%20tests%20Suite/badge.svg?branch=develop&amp;event=push" alt="Unit tests Suite"></a>
   <a><img src="https://github.com/docsifyjs/docsify/workflows/Linting%20Checks/badge.svg?branch=develop&amp;event=push" alt="Linting Checks"></a>
   <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>
@@ -41,7 +41,7 @@
 ## Features
 
 - No statically built html files
-- Simple and lightweight (~21kB gzipped)
+- Simple and lightweight
 - Smart full-text search plugin
 - Multiple themes
 - Useful plugin API
@@ -123,3 +123,9 @@ This project exists thanks to all the people who contribute. [[Contribute](CONTR
 ## License
 
 [MIT](LICENSE)
+
+## Special Thanks
+
+_Vercel_ has given us a Pro account.
+
+<a href="https://vercel.com/?utm_source=docsifyjsdocs" target="_blank"><img src="docs/_media/vercel_logo.svg" width="100px"></a>

build/build.js

@@ -22,14 +22,27 @@ async function build(opts) {
     .rollup({
       input: opts.input,
       plugins: (opts.plugins || []).concat([
-        buble(),
+        buble({
+          transforms: {
+            dangerousForOf: true
+          }}),
         commonjs(),
         nodeResolve(),
         replace({
           __VERSION__: version,
           'process.env.SSR': false
         })
-      ])
+      ]),
+      onwarn: function (message) {
+        if (message.code === 'UNRESOLVED_IMPORT') {
+          throw new Error(
+            `Could not resolve module ` +
+            message.source +
+            `. Try running 'npm install' or using rollup's 'external' option if this is an external dependency. ` +
+            `Module ${message.source} is imported in ${message.importer}`
+            )
+        }
+      }
     })
     .then(function (bundle) {
       var dest = 'lib/' + (opts.output || opts.input)

cypress/fixtures/tpl/docs.index.html

@@ -1,123 +1,112 @@
 <!DOCTYPE html>
 <html lang="en">
-  <head>
-    <meta charset="UTF-8" />
-    <title>docsify-e2e-tests</title>
-    <link rel="icon" href="_media/favicon.ico" />
-    <meta
-      name="google-site-verification"
-      content="6t0LoIeFksrjF4c9sqUEsVXiQNxLp2hgoqo0KryT-sE"
-    />
-    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
-    <meta
-      name="keywords"
-      content="doc,docs,documentation,gitbook,creator,generator,github,jekyll,github-pages"
-    />
-    <meta name="description" content="A magical documentation generator." />
-    <meta
-      name="viewport"
-      content="width=device-width, initial-scale=1.0, minimum-scale=1.0"
-    />
-    <link rel="stylesheet" href="lib/themes/vue.css" title="vue" />
-    <link rel="stylesheet" href="lib/themes/dark.css" title="dark" disabled />
-    <link rel="stylesheet" href="lib/themes/buble.css" title="buble" disabled />
-    <link rel="stylesheet" href="lib/themes/pure.css" title="pure" disabled />
-    <script src="//unpkg.com/docsify-plugin-codefund/index.js"></script>
-    <style>
-      nav.app-nav li ul {
-        min-width: 100px;
-      }
-    </style>
-  </head>
 
-  <body>
-    <div id="app">Loading Docsify e2e tests suite...</div>
-    <script>
-      window.$docsify = {
-        alias: {
-          '.*?/awesome':
-            'https://raw.githubusercontent.com/docsifyjs/awesome-docsify/master/README.md',
-          '.*?/changelog':
-            'https://raw.githubusercontent.com/docsifyjs/docsify/master/CHANGELOG.md',
-          '/.*/_navbar.md': '/_navbar.md',
-          '/zh-cn/(.*)':
-            'https://raw.githubusercontent.com/docsifyjs/docs-zh/master/$1',
-          '/de-de/(.*)':
-            'https://raw.githubusercontent.com/docsifyjs/docs-de/master/$1',
-          '/ru/(.*)':
-            'https://raw.githubusercontent.com/docsifyjs/docs-ru/master/$1',
-          '/es/(.*)':
-            'https://raw.githubusercontent.com/docsifyjs/docs-es/master/$1'
-        },
-        auto2top: true,
-        coverpage: true,
-        executeScript: true,
-        loadSidebar: true,
-        loadNavbar: true,
-        mergeNavbar: true,
-        maxLevel: 4,
-        subMaxLevel: 2,
-        ga: 'UA-106147152-1',
-        matomo: {
-          host: '//matomo.thunderwave.de',
-          id: 6
-        },
-        name: 'docsify',
-        search: {
-          noData: {
-            '/de-de/': 'Keine Ergebnisse!',
-            '/zh-cn/': '没有结果!',
-            '/': 'No results!'
-          },
-          paths: 'auto',
-          placeholder: {
-            '/de-de/': 'Suche',
-            '/zh-cn/': '搜索',
-            '/': 'Search'
-          }
+<head>
+  <meta charset="UTF-8" />
+  <title>docsify-e2e-tests</title>
+  <link rel="icon" href="_media/favicon.ico" />
+  <meta name="google-site-verification" content="6t0LoIeFksrjF4c9sqUEsVXiQNxLp2hgoqo0KryT-sE" />
+  <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
+  <meta name="keywords" content="doc,docs,documentation,gitbook,creator,generator,github,jekyll,github-pages" />
+  <meta name="description" content="A magical documentation generator." />
+  <meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0" />
+  <link rel="stylesheet" href="lib/themes/vue.css" title="vue" />
+  <link rel="stylesheet" href="lib/themes/dark.css" title="dark" disabled />
+  <link rel="stylesheet" href="lib/themes/buble.css" title="buble" disabled />
+  <link rel="stylesheet" href="lib/themes/pure.css" title="pure" disabled />
+  <style>
+    nav.app-nav li ul {
+      min-width: 100px;
+    }
+  </style>
+</head>
+
+<body>
+  <div id="app">Loading Docsify e2e tests suite...</div>
+  <script>
+    window.$docsify = {
+      alias: {
+        '.*?/awesome':
+          'https://raw.githubusercontent.com/docsifyjs/awesome-docsify/master/README.md',
+        '/changelog':
+          'https://raw.githubusercontent.com/docsifyjs/docsify/master/CHANGELOG.md',
+        '/.*/_navbar.md': '/_navbar.md',
+        '/zh-cn/(.*)':
+          'https://raw.githubusercontent.com/docsifyjs/docs-zh/master/$1',
+        '/de-de/(.*)':
+          'https://raw.githubusercontent.com/docsifyjs/docs-de/master/$1',
+        '/ru/(.*)':
+          'https://raw.githubusercontent.com/docsifyjs/docs-ru/master/$1',
+        '/es/(.*)':
+          'https://raw.githubusercontent.com/docsifyjs/docs-es/master/$1'
+      },
+      fallbackLanguages: ['es'],
+      auto2top: true,
+      coverpage: true,
+      executeScript: true,
+      loadSidebar: true,
+      loadNavbar: true,
+      mergeNavbar: true,
+      maxLevel: 4,
+      subMaxLevel: 2,
+      ga: 'UA-106147152-1',
+      matomo: {
+        host: '//matomo.thunderwave.de',
+        id: 6
+      },
+      name: 'docsify',
+      search: {
+        noData: {
+          '/de-de/': 'Keine Ergebnisse!',
+          '/zh-cn/': '没有结果!',
+          '/': 'No results!'
         },
-        formatUpdated: '{MM}/{DD} {HH}:{mm}',
-        plugins: [
-          function(hook, vm) {
-            hook.beforeEach(function(html) {
-              if (/githubusercontent\.com/.test(vm.route.file)) {
-                url = vm.route.file
-                  .replace('raw.githubusercontent.com', 'github.com')
-                  .replace(/\/master/, '/blob/master')
-              } else {
-                url =
-                  'https://github.com/docsifyjs/docsify/blob/master/docs/' +
-                  vm.route.file
-              }
-              var editHtml = '[:memo: Edit Document](' + url + ')\n'
-              return (
-                editHtml +
-                html +
-                '\n\n----\n\n' +
-                '<a href="https://docsify.js.org" target="_blank" style="color: inherit; font-weight: normal; text-decoration: none;">Powered by docsify</a>'
-              )
-            })
-          }
-        ]
-      }
-    </script>
-    <script src="lib/docsify.min.js"></script>
-    <script src="lib/plugins/search.min.js"></script>
-    <script src="lib/plugins/ga.min.js"></script>
-    <script src="lib/plugins/matomo.min.js"></script>
-    <script src="//unpkg.com/prismjs/components/prism-bash.min.js"></script>
-    <script src="//unpkg.com/prismjs/components/prism-markdown.min.js"></script>
-    <script src="//unpkg.com/prismjs/components/prism-nginx.min.js"></script>
+        paths: 'auto',
+        placeholder: {
+          '/de-de/': 'Suche',
+          '/zh-cn/': '搜索',
+          '/': 'Search'
+        }
+      },
+      formatUpdated: '{MM}/{DD} {HH}:{mm}',
+      plugins: [
+        function (hook, vm) {
+          hook.beforeEach(function (html) {
+            if (/githubusercontent\.com/.test(vm.route.file)) {
+              url = vm.route.file
+                .replace('raw.githubusercontent.com', 'github.com')
+                .replace(/\/master/, '/blob/master')
+            } else {
+              url =
+                'https://github.com/docsifyjs/docsify/blob/master/docs/' +
+                vm.route.file
+            }
+            var editHtml = '[:memo: Edit Document](' + url + ')\n'
+            return (
+              editHtml +
+              html +
+              '\n\n----\n\n' +
+              '<a href="https://docsify.js.org" target="_blank" style="color: inherit; font-weight: normal; text-decoration: none;">Powered by docsify</a>'
+            )
+          })
+        }
+      ]
+    }
+  </script>
+  <script src="lib/docsify.min.js"></script>
+  <script src="lib/plugins/search.min.js"></script>
+  <script src="lib/plugins/ga.min.js"></script>
+  <script src="lib/plugins/matomo.min.js"></script>
+  <script src="//unpkg.com/prismjs/components/prism-bash.min.js"></script>
+  <script src="//unpkg.com/prismjs/components/prism-markdown.min.js"></script>
+  <script src="//unpkg.com/prismjs/components/prism-nginx.min.js"></script>
 
-    <script>
-      ;((window.gitter = {}).chat = {}).options = {
+  <script>
+      ; ((window.gitter = {}).chat = {}).options = {
         room: 'docsifyjs/Lobby'
       }
-    </script>
-    <script
-      src="https://sidecar.gitter.im/dist/sidecar.v1.js"
-      async
-      defer
-    ></script>
-  </body>
-</html>
+  </script>
+  <script src="https://sidecar.gitter.im/dist/sidecar.v1.js" async defer></script>
+</body>
+
+</html>

cypress/integration/routing/fallback.spec.js

@@ -0,0 +1,9 @@
+context('config.fallbackLanguages', () => {
+  it('fallbacks respecting aliases', () => {
+    cy.visit('http://localhost:3000/#/es/');
+
+    cy.get('.sidebar-nav').contains('Changelog').click();
+
+    cy.get('#main').should('contain', 'Bug Fixes');
+  })
+});

cypress/integration/sidebar/config.spec.js

@@ -157,7 +157,6 @@ context('sidebar.configurations', () => {
     'disqus',
     'gitalk',
     'pagination',
-    'codefund',
     'tabs',
     'more-plugins',
   ];