Merge branch 'develop' into docker/doc

Author: anikethsaha

.codesandbox/ci.json

@@ -0,0 +1,4 @@
+{
+  "sandboxes": ["2d17z"],
+  "packages": [".", "packages/docsify-server-renderer"]
+}

.editorconfig

@@ -0,0 +1,11 @@
+# http://EditorConfig.org
+
+root = true
+
+[*]
+charset = utf-8
+indent_style = space
+indent_size = 2
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true

.eslintrc.js

@@ -19,6 +19,7 @@ module.exports = {
   rules: {
     'prettier/prettier': ['error'],
     camelcase: ['warn'],
+    'no-useless-escape': ['warn'],
     curly: ['error', 'all'],
     'dot-notation': ['error'],
     eqeqeq: ['error'],

.github/ISSUE_TEMPLATE/bug_report.md

@@ -7,6 +7,7 @@ about: Create a report to help us improve
 <!-- Please use English language -->
 <!-- Before creating an issue please make sure you are using the latest version of Docsify. -->
 <!-- Please ask questions on StackOverflow: https://stackoverflow.com/questions/ask?tags=docsify -->
+<!-- Please ask questions on gitter: https://gitter.im/docsifyjs/Lobby -->
 
 ## Bug Report
 
@@ -36,3 +37,9 @@ about: Create a report to help us improve
 
 <!-- Love docsify? Please consider supporting our collective:
 👉  https://opencollective.com/docsify/donate -->
+
+#### Please create a reproducible sandbox 
+
+[![Edit 307qqv236](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/307qqv236)
+
+#### Mention the docsify version in which this bug was not present (if any)

.github/semantic.yml

@@ -0,0 +1,4 @@
+titleAndCommits: true
+allowMergeCommits: true
+allowRevertCommits: true
+anyCommit: true

.gitpod.yml

@@ -0,0 +1,10 @@
+tasks:
+  - command: gp await-port 3000 && sleep 3 && gp preview $(gp url 3000)
+  - init: npm install
+    command: npm run dev
+ports:
+  - port: 3000
+    onOpen: ignore
+vscode:
+  extensions:
+    - [email protected]:xX39oruAJ5UQzTNVRdbBaQ==

CHANGELOG.md

@@ -1,3 +1,50 @@
+## [4.11.4](https://github.com/docsifyjs/docsify/compare/v4.11.3...v4.11.4) (2020-06-18)
+
+
+### Bug Fixes
+
+* consistent location of search result ([e9dd2de](https://github.com/docsifyjs/docsify/commit/e9dd2de384b81619aae2bcbf92f52721cb76a177))
+* cover overlapping sidebar by removing z-index ([0bf03f5](https://github.com/docsifyjs/docsify/commit/0bf03f58103037d100b1635cf3989c8d3672b4ba))
+* cross-origin url cannot be redirected when  "externalLinkTarget" is set to "_self" and "routerMode" is set to "history". ([#1062](https://github.com/docsifyjs/docsify/issues/1062)) ([fd2cec6](https://github.com/docsifyjs/docsify/commit/fd2cec6bd66c46d6957811fefae4c615c3052a4f)), closes [#1046](https://github.com/docsifyjs/docsify/issues/1046) [#1046](https://github.com/docsifyjs/docsify/issues/1046) [#1046](https://github.com/docsifyjs/docsify/issues/1046)
+* default html img resize if no height included ([#1065](https://github.com/docsifyjs/docsify/issues/1065)) ([9ff4d06](https://github.com/docsifyjs/docsify/commit/9ff4d0677304bc190e7bd9e89bbbdc64895197fa))
+* fixed target and rel issue (fixes [#1183](https://github.com/docsifyjs/docsify/issues/1183)) ([3d662a5](https://github.com/docsifyjs/docsify/commit/3d662a5bf71bbfef077cfbc478df241d794f55a0))
+* Inconsistent search and body rendering ([dcb0aae](https://github.com/docsifyjs/docsify/commit/dcb0aaea99efbd68175f1d1aeb5076b6dde9801e))
+* rendering cover width bug ([717991c](https://github.com/docsifyjs/docsify/commit/717991c90cf709f4da91fe32610129de6529266b))
+* search does not find the contents of the table ([#1198](https://github.com/docsifyjs/docsify/issues/1198)) ([31010e4](https://github.com/docsifyjs/docsify/commit/31010e4979b3d3ab4bd247a09c4ac5fd1405eaa8))
+* The search error after setting the ID in the title ([#1159](https://github.com/docsifyjs/docsify/issues/1159)) ([6e554f8](https://github.com/docsifyjs/docsify/commit/6e554f8ebd3d4a2c5c7e4f66cff3dfe2b6aa1e31))
+* upgrade docsify from 4.10.2 to 4.11.2 ([60b7f89](https://github.com/docsifyjs/docsify/commit/60b7f89b373b0d48ec8406a51eddeaed8126696d))
+
+
+### Features
+
+* added html sanitizer for remote rendering ([#1128](https://github.com/docsifyjs/docsify/issues/1128)) ([714ef29](https://github.com/docsifyjs/docsify/commit/714ef29afe779a6db5c4761ebaacdfc70ee2d8dd))
+* update src/core/index.js to export all global APIs, deprecate old globals in favor of a single global DOCSIFY, and add tests for this ([7e002bf](https://github.com/docsifyjs/docsify/commit/7e002bf939d7837843908417b5445b4f8d36c1cd))
+
+
+### Reverts
+
+* Revert "Updated docs site dark and light mode with switch and redesigned search bar using docsify-darklight-theme" (#1207) ([26cb940](https://github.com/docsifyjs/docsify/commit/26cb940b51d34ee584b8425012a336f38a4abd76)), closes [#1207](https://github.com/docsifyjs/docsify/issues/1207) [#1182](https://github.com/docsifyjs/docsify/issues/1182)
+
+
+
+## [4.11.3](https://github.com/docsifyjs/docsify/compare/v4.11.2...v4.11.3) (2020-03-24)
+
+
+### Bug Fixes
+
+* fix: digit issue with sidebar (complete REVERT to old method) ([154abf5](https://github.com/docsifyjs/docsify/commit/154abf59a6153e84b018fcdffa86892776d6da7d))
+
+
+
+## [4.11.2](https://github.com/docsifyjs/docsify/compare/v4.11.1...v4.11.2) (2020-03-09)
+
+
+### Bug Fixes
+
+* fixed rendering of color in coverpage issue ([406670c](https://github.com/docsifyjs/docsify/commit/406670c3d619a627142900fd45019fb8ce00f60a))
+
+
+
 ## [4.11.1](https://github.com/docsifyjs/docsify/compare/v4.11.0...v4.11.1) (2020-03-09)
 
 

README.md

@@ -18,6 +18,7 @@
   <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>
+  <a href="https://gitpod.io/#https://github.com/docsifyjs/docsify"><img src="https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod" alt="Gitpod Ready-to-Code"></a>
 </p>
 
 <p align="center">Gold Sponsor via <a href="https://opencollective.com/docsify">Open Collective</a></p>
@@ -69,6 +70,18 @@ Move to [awesome-docsify](https://github.com/docsifyjs/awesome-docsify#showcase)
 
 ## Contributing
 
+### Online one-click setup for Contributing
+
+You can use Gitpod(A free online VS Code-like IDE) for contributing. With single click it'll launch a workspace and automatically:
+
+- clone the docsify repo.
+- install the dependencies.
+- start `npm run dev`.
+
+So that you can start straight away.
+
+[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/docsifyjs/docsify)
+
 - Fork it!
 - Create your feature branch: `git checkout -b my-new-feature`
 - Commit your changes: `git commit -am 'Add some feature'`

build/build.js

@@ -9,8 +9,16 @@ const version = process.env.VERSION || require('../package.json').version
 const chokidar = require('chokidar')
 const path = require('path')
 
-const build = function (opts) {
-  rollup
+/**
+ * @param {{
+ *   input: string,
+ *   output?: string,
+ *   globalName?: string,
+ *   plugins?: Array<import('rollup').Plugin>
+ * }} opts
+ */
+async function build(opts) {
+  await rollup
     .rollup({
       input: opts.input,
       plugins: (opts.plugins || []).concat([
@@ -27,31 +35,35 @@ const build = function (opts) {
       var dest = 'lib/' + (opts.output || opts.input)
 
       console.log(dest)
-      bundle.write({
+      return bundle.write({
         format: 'iife',
+        output: opts.globalName ? {name: opts.globalName} : {},
         file: dest,
         strict: false
       })
     })
-    .catch(function (err) {
-      console.error(err)
-    })
 }
-const buildCore = function () {
-  build({
+
+async function buildCore() {
+  const promises = []
+
+  promises.push(build({
     input: 'src/core/index.js',
-    output: 'docsify.js'
-  })
+    output: 'docsify.js',
+  }))
 
   if (isProd) {
-    build({
+    promises.push(build({
       input: 'src/core/index.js',
       output: 'docsify.min.js',
       plugins: [uglify()]
-    })
+    }))
   }
+
+  await Promise.all(promises)
 }
-const buildAllPlugin = function () {
+
+async function buildAllPlugin() {
   var plugins = [
     {name: 'search', input: 'search/index.js'},
     {name: 'ga', input: 'ga.js'},
@@ -64,56 +76,68 @@ const buildAllPlugin = function () {
     {name: 'gitalk', input: 'gitalk.js'}
   ]
 
-  plugins.forEach(item => {
-    build({
+  const promises = plugins.map(item => {
+    return build({
       input: 'src/plugins/' + item.input,
       output: 'plugins/' + item.name + '.js'
     })
   })
 
   if (isProd) {
     plugins.forEach(item => {
-      build({
+      promises.push(build({
         input: 'src/plugins/' + item.input,
         output: 'plugins/' + item.name + '.min.js',
         plugins: [uglify()]
-      })
+      }))
     })
   }
+
+  await Promise.all(promises)
 }
 
-if (!isProd) {
-  chokidar
-    .watch(['src/core', 'src/plugins'], {
-      atomic: true,
-      awaitWriteFinish: {
-        stabilityThreshold: 1000,
-        pollInterval: 100
-      }
-    })
-    .on('change', p => {
-      console.log('[watch] ', p)
-      const dirs = p.split(path.sep)
-      if (dirs[1] === 'core') {
-        buildCore()
-      } else if (dirs[2]) {
-        const name = path.basename(dirs[2], '.js')
-        const input = `src/plugins/${name}${
-          /\.js/.test(dirs[2]) ? '' : '/index'
-        }.js`
+async function main() {
+  if (!isProd) {
+    chokidar
+      .watch(['src/core', 'src/plugins'], {
+        atomic: true,
+        awaitWriteFinish: {
+          stabilityThreshold: 1000,
+          pollInterval: 100
+        }
+      })
+      .on('change', p => {
+        console.log('[watch] ', p)
+        const dirs = p.split(path.sep)
+        if (dirs[1] === 'core') {
+          buildCore()
+        } else if (dirs[2]) {
+          const name = path.basename(dirs[2], '.js')
+          const input = `src/plugins/${name}${
+            /\.js/.test(dirs[2]) ? '' : '/index'
+          }.js`
 
-        build({
-          input,
-          output: 'plugins/' + name + '.js'
-        })
-      }
-    })
-    .on('ready', () => {
-      console.log('[start]')
-      buildCore()
+          build({
+            input,
+            output: 'plugins/' + name + '.js'
+          })
+        }
+      })
+      .on('ready', () => {
+        console.log('[start]')
+        buildCore()
+        buildAllPlugin()
+      })
+  } else {
+    await Promise.all([
+      buildCore(),
       buildAllPlugin()
-    })
-} else {
-  buildCore()
-  buildAllPlugin()
+    ])
+  }
 }
+
+main().catch((e) => {
+  console.error(e)
+  process.exit(1)
+})
+

build/css.js

@@ -5,8 +5,8 @@ const {spawn} = require('child_process')
 const args = process.argv.slice(2)
 fs.readdir(path.join(__dirname, '../src/themes'), (err, files) => {
     if (err) {
-        console.log('err', err)
-        return
+        console.error('err', err)
+        process.exit(1)
     }
     files.map(async (file) => {
         if (/\.styl/g.test(file)) {
@@ -31,11 +31,17 @@ fs.readdir(path.join(__dirname, '../src/themes'), (err, files) => {
             });
 
             stylusCMD.on('close', (code) => {
-                console.log(`[Stylus Build ] child process exited with code ${code}`);
+                const message = `[Stylus Build ] child process exited with code ${code}`
+
+                if (code !== 0) {
+                  console.error(message);
+                  process.exit(code)
+                }
+                console.log(message);
             });
         } else {
             return
         }
 
     })
-})
+})

build/mincss.js

@@ -8,5 +8,8 @@ files.forEach(file => {
   file = path.resolve('lib/themes', file)
   cssnano(fs.readFileSync(file)).then(result => {
     fs.writeFileSync(file, result.css)
+  }).catch(e => {
+    console.error(e)
+    process.exit(1)
   })
 })

build/ssr.js

@@ -24,11 +24,12 @@ rollup
     var dest = 'packages/docsify-server-renderer/build.js'
 
     console.log(dest)
-    bundle.write({
+    return bundle.write({
       format: 'cjs',
       file: dest
     })
   })
   .catch(function (err) {
     console.error(err)
+    process.exit(1)
   })

cypress/fixtures/tpl/docs.index.html

@@ -16,7 +16,7 @@
     <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"
+      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 />

docs/_coverpage.md

@@ -1,6 +1,6 @@
 ![logo](_media/icon.svg)
 
-# docsify <small>4.11.1</small>
+# docsify <small>4.11.4</small>
 
 > A magical documentation site generator.
 

docs/_media/example-with-yaml.md

@@ -0,0 +1,6 @@
+---
+author: John Smith
+date: 2020-1-1
+---
+
+> This is from the `example.md`