[Pre-release]: Tracking changes for pre-release of v4.11.0

.eslintignore

@@ -2,4 +2,10 @@
 packages/docsify-server-renderer/build.js
 node_modules
 build
-server.js
+server.js
+cypress
+lib
+themes
+build
+docs/
+**/*.md

.eslintrc.js

@@ -0,0 +1,63 @@
+module.exports = {
+  root: true,
+  parser: 'babel-eslint',
+  parserOptions: {
+    sourceType: 'module',
+    ecmaVersion: 2019,
+  },
+  env: {
+    jest: true,
+    browser: true,
+    node: true,
+    es6: true,
+  },
+  plugins: ['prettier', 'import'],
+  extends: ['eslint:recommended', 'plugin:import/recommended'],
+  settings: {
+    'import/ignore': ['node_modules', '.json$'],
+  },
+  rules: {
+    'prettier/prettier': ['error'],
+    camelcase: ['warn'],
+    curly: ['error', 'all'],
+    'dot-notation': ['error'],
+    eqeqeq: ['error'],
+    'handle-callback-err': ['error'],
+    'new-cap': ['error'],
+    'no-alert': ['error'],
+    'no-caller': ['error'],
+    'no-eval': ['error'],
+    'no-labels': ['error'],
+    'no-lonely-if': ['error'],
+    'no-new': ['error'],
+    'no-proto': ['error'],
+    'no-return-assign': ['error'],
+    'no-self-compare': ['error'],
+    'no-shadow': ['warn'],
+    'no-shadow-restricted-names': ['error'],
+    'no-useless-call': ['error'],
+    'no-var': ['error'],
+    'no-void': ['error'],
+    'no-with': ['error'],
+    radix: ['error'],
+    'spaced-comment': ['error', 'always'],
+    strict: ['error', 'global'],
+    yoda: ['error', 'never'],
+
+    // Import rules
+    // Search way how integrate with `lerna`
+    'import/no-unresolved': 'off',
+    'import/imports-first': ['error'],
+    'import/newline-after-import': ['error'],
+    'import/no-duplicates': ['error'],
+    'import/no-mutable-exports': ['error'],
+    'import/no-named-as-default': ['error'],
+    'import/no-named-as-default-member': ['error'],
+    'import/order': ['warn'],
+  },
+  globals: {
+    Docsify: 'writable',
+    $docsify: 'writable',
+    dom: 'writable',
+  },
+};

.github/stale.yml

@@ -0,0 +1,20 @@
+# Number of days of inactivity before an issue becomes stale
+daysUntilStale: 60
+# Number of days of inactivity before a stale issue is closed
+daysUntilClose: 7
+# Issues with these labels will never be considered stale
+exemptLabels:
+  - pinned
+  - security
+  - On hold
+  - enhancement
+  - bug
+# Label to use when marking an issue as stale
+staleLabel: wontfix
+# Comment to post when marking an issue as stale. Set to `false` to disable
+markComment: >
+  This issue has been automatically marked as stale because it has not had
+  recent activity. It will be closed if no further activity occurs. Thank you
+  for your contributions.
+# Comment to post when closing a stale issue. Set to `false` to disable
+closeComment: false

.github/workflows/e2e.yml

@@ -0,0 +1,31 @@
+name: Testing the e2e test suites
+
+on: 
+  push:
+   branches:
+    - master
+    - develop
+  pull_request:
+   branches:
+    - master
+    - develop
+
+jobs:
+  build:
+    runs-on: ubuntu-16.04
+    strategy:
+      matrix:
+        node-version: [10.x, 12.x, 13.x]
+
+    steps:
+    - uses: actions/checkout@v1
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v1
+      with:
+        node-version: ${{ matrix.node-version }}
+    - name:  bootstrap
+      run: npm run bootstrap
+    - name: Build
+      run: npm run build
+    - name: end to end
+      run: npm run test:e2e

.github/workflows/lint.yml

@@ -0,0 +1,31 @@
+name: Linting Checks
+
+on: 
+  push:
+   branches:
+    - master
+    - develop
+  pull_request:
+   branches:
+    - master
+    - develop
+
+jobs:
+  build:
+    runs-on: ubuntu-16.04
+    strategy:
+      matrix:
+        node-version: [10.x, 12.x, 13.x]
+
+    steps:
+    - uses: actions/checkout@v1
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v1
+      with:
+        node-version: ${{ matrix.node-version }}
+    - name:  bootstrap
+      run: npm run bootstrap
+    - name: Build
+      run: npm run build
+    - name: Linting
+      run: npm run lint

.github/workflows/unit.yml

@@ -0,0 +1,31 @@
+name: Unit tests Suite
+
+on: 
+  push:
+   branches:
+    - master
+    - develop
+  pull_request:
+   branches:
+    - master
+    - develop
+
+jobs:
+  build:
+    runs-on: ubuntu-16.04
+    strategy:
+      matrix:
+        node-version: [10.x, 12.x, 13.x]
+
+    steps:
+    - uses: actions/checkout@v1
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v1
+      with:
+        node-version: ${{ matrix.node-version }}
+    - name:  bootstrap
+      run: npm run bootstrap
+    - name: Build
+      run: npm run build
+    - name: Unit tests
+      run: npm run test

.gitignore

@@ -4,6 +4,8 @@
 node_modules
 themes/
 lib/
+cypress/integration/examples
+cypress/fixtures/docs
 
 # exceptions
 !.gitkeep

.prettierrc.js

@@ -0,0 +1,4 @@
+module.exports = {
+  singleQuote: true,
+  trailingComma: 'es5',
+};

.vscode/settings.json

@@ -1,4 +1,3 @@
 {
-  "editor.defaultFormatter": "esbenp.prettier-vscode",
-  "editor.formatOnSave": true
+  "editor.defaultFormatter": "esbenp.prettier-vscode"
 }

README.md

@@ -1,6 +1,6 @@
 <p align="center">
   <a href="https://docsify.js.org">
-    <img alt="docsify" src="./docs/_media/icon.svg">
+    <img alt="docsify" src="https://github.com/docsifyjs/docsify/blob/develop/docs/_media/icon.svg">
   </a>
 </p>
 
@@ -10,8 +10,11 @@
 
 <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>
-  <a href="https://travis-ci.org/docsifyjs/docsify"><img alt="Travis Status" src="https://img.shields.io/travis/docsifyjs/docsify/master.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> 
+  <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>
   <a href="https://www.npmjs.com/package/docsify"><img alt="npm" src="https://img.shields.io/npm/v/docsify.svg?style=flat-square"></a>
   <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>
   <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>
@@ -107,5 +110,3 @@ This project exists thanks to all the people who contribute. [[Contribute](CONTR
 ## License
 
 [MIT](LICENSE)
-
-[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bhttps%3A%2F%2Fgithub.com%2Fdocsifyjs%2Fdocsify.svg?type=large)](https://app.fossa.io/projects/git%2Bhttps%3A%2F%2Fgithub.com%2Fdocsifyjs%2Fdocsify?ref=badge_large)

cypress.json

@@ -0,0 +1,3 @@
+{
+  "video": false
+}

cypress/fixtures/tpl/docs.index.html

@@ -0,0 +1,123 @@
+<!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, user-scalable=no, initial-scale=1.0, maximum-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'
+          }
+        },
+        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 = {
+        room: 'docsifyjs/Lobby'
+      }
+    </script>
+    <script
+      src="https://sidecar.gitter.im/dist/sidecar.v1.js"
+      async
+      defer
+    ></script>
+  </body>
+</html>