Merge branch 'develop' into prepare-script

Author: trusktr

.eslintrc

@@ -1,7 +1,10 @@
 {
   "extends": "xo-space/browser",
   "rules": {
-    "semi": [2, "never"],
+    "semi": [
+      2,
+      "never"
+    ],
     "no-return-assign": "off",
     "no-unused-expressions": "off",
     "no-new-func": "off",
@@ -10,11 +13,22 @@
     "max-params": "off",
     "no-script-url": "off",
     "camelcase": "off",
-    "no-warning-comments": "off"
+    "object-curly-spacing": "off",
+    "no-warning-comments": "off",
+    "no-negated-condition": "off",
+    "eqeqeq": "warn",
+    "no-eq-null": "warn",
+    "max-statements-per-line": "warn"
   },
   "globals": {
     "Docsify": true,
     "$docsify": true,
     "process": true
+  },
+  "env": {
+    "browser": true,
+    "amd": true,
+    "node": true,
+    "jest": true
   }
-}
+}

.github/FUNDING.yml

@@ -0,0 +1,2 @@
+open_collective: docsify
+

.github/workflows/CI.yml

@@ -0,0 +1,33 @@
+name: Testing the e2e test suites
+
+on: 
+  push:
+   branches:
+    - master
+    - develop
+  pull_request:
+   branches:
+    - master
+    - develop
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [8.x, 10.x, 12.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
+    - name: end to end
+      run: npm run test:e2e

.travis.yml

@@ -1,3 +1,6 @@
 sudo: false
 language: node_js
 node_js: stable
+
+script:
+  - npm run lint

.vscode/settings.json

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

CHANGELOG.md

@@ -1,3 +1,19 @@
+## [4.10.2](https://github.com/docsifyjs/docsify/compare/v4.10.0...v4.10.2) (2019-12-16)
+
+
+
+# [4.10.0](https://github.com/docsifyjs/docsify/compare/v4.9.4...v4.10.0) (2019-12-16)
+
+
+### Bug Fixes
+
+* fixed security alert for chokidar(update dep) ([a62b037](https://github.com/docsifyjs/docsify/commit/a62b037becb36941c11c8eab6e4d83df8db85af3))
+* npm audit issues ([#934](https://github.com/docsifyjs/docsify/issues/934)) ([615205c](https://github.com/docsifyjs/docsify/commit/615205cfdb7aea8f37a1ec5dd928105eeef56357))
+* package security alerts ([f5f1561](https://github.com/docsifyjs/docsify/commit/f5f15619f1a239d6ce12a2f83ad8817352a3352b))
+* security alerts of cssnano ([d7d5c8f](https://github.com/docsifyjs/docsify/commit/d7d5c8f302d7c18dbb32e982202a07b73badf6f6))
+
+
+
 <a name="4.9.4"></a>
 ## [4.9.4](https://github.com/docsifyjs/docsify/compare/v4.9.2...v4.9.4) (2019-05-05)
 

build/build.js

@@ -2,7 +2,7 @@ const rollup = require('rollup')
 const buble = require('rollup-plugin-buble')
 const commonjs = require('rollup-plugin-commonjs')
 const nodeResolve = require('rollup-plugin-node-resolve')
-const uglify = require('rollup-plugin-uglify')
+const { uglify } = require('rollup-plugin-uglify')
 const replace = require('rollup-plugin-replace')
 const isProd = process.env.NODE_ENV === 'production'
 const version = process.env.VERSION || require('../package.json').version

build/css.js

@@ -0,0 +1,41 @@
+const fs = require('fs')
+const path = require('path')
+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
+    }
+    files.map(async (file) => {
+        if (/\.styl/g.test(file)) {
+            var stylusCMD;
+            const stylusBin = ['node_modules', 'stylus', 'bin', 'stylus'].join(path.sep)
+            var cmdargs = [
+                stylusBin,
+                `src/themes/${file}`,
+                '-u',
+                'autoprefixer-stylus'
+            ]
+            cmdargs = cmdargs.concat(args)
+
+            stylusCMD = spawn('node', cmdargs, { shell: true })
+
+            stylusCMD.stdout.on('data', (data) => {
+                console.log(`[Stylus Build ] stdout: ${data}`);
+            });
+
+            stylusCMD.stderr.on('data', (data) => {
+                console.error(`[Stylus Build ] stderr: ${data}`);
+            });
+
+            stylusCMD.on('close', (code) => {
+                console.log(`[Stylus Build ] child process exited with code ${code}`);
+            });
+        } else {
+            return
+        }
+
+    })
+})

build/release.sh

@@ -12,7 +12,9 @@ echo
 if [[ $REPLY =~ ^[Yy]$ ]]; then
   echo "Releasing $VERSION ..."
 
-  npm run test
+  # Removing test script as non - availibity of tests. Will Add it once tests are completed 
+
+  # npm run test
 
   # build
   VERSION=$VERSION npm run build

docs/_coverpage.md

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

docs/_media/example.js

@@ -5,12 +5,12 @@ const PORT = 8080
 
 /// [demo]
 const result = fetch(`${URL}:${PORT}`)
-  .then(function(response) {
-    return response.json();
+  .then(function (response) {
+    return response.json()
+  })
+  .then(function (myJson) {
+    console.log(JSON.stringify(myJson))
   })
-  .then(function(myJson) {
-    console.log(JSON.stringify(myJson));
-  });
 /// [demo]
 
 result.then(console.log).catch(console.error)

docs/configuration.md

@@ -239,6 +239,14 @@ window.$docsify = {
 };
 ```
 
+The name field can also contain custom HTML for easier customization:
+
+```js
+window.$docsify = {
+  name: '<span>docsify</span>'
+};
+```
+
 ## nameLink
 
 - Type: `String`
@@ -397,14 +405,40 @@ window.$docsify = {
 - type: `String`
 - default: `_blank`
 
-Target to open external links. Default `'_blank'` (new window/tab)
+Target to open external links inside the markdown. Default `'_blank'` (new window/tab)
 
 ```js
 window.$docsify = {
   externalLinkTarget: '_self' // default: '_blank'
 };
 ```
 
+## cornerExternalLinkTarget
+
+- type:`String`
+- default:`_blank`
+
+Target to open external link at the top right corner. Default `'_blank'` (new window/tab)
+
+```js
+window.$docsify = {
+  cornerExternalLinkTarget: '_self' // default: '_blank'
+};
+```
+
+## externalLinkRel
+
+- type: `String`
+- default: `noopener`
+
+Default `'noopener'` (no opener) prevents the newly opened external page (when [externalLinkTarget](#externallinktarget) is `'_blank'`) from having the ability to control our page. No `rel` is set when its not `'_blank'`.
+
+```js
+window.$docsify = {
+  externalLinkTarget: '' // default: 'noopener'
+};
+```
+
 ## routerMode
 
 - type: `String`
@@ -454,6 +488,18 @@ window.$docsify = {
 };
 ```
 
+Such as setting the cache
+
+```js
+window.$docsify = {
+  requestHeaders: {
+    'cache-control': 'max-age=600'
+  }
+};
+```
+
+
+
 ## ext
 
 - type: `String`

docs/deploy.md

@@ -82,12 +82,18 @@ server {
 
 ### HTML5 router
 
-When using the HTML5 router, you need to set up redirect rules that redirect all requests to your `index.html`, it's pretty simple when you're using Netlify, populate a `\redirects` file in the docs directory and you're all set:
+When using the HTML5 router, you need to set up redirect rules that redirect all requests to your `index.html`, it's pretty simple when you're using Netlify, create a file named `_redirects` in the docs directory, add this snippet to the file and you're all set:
 
 ```sh
 /*    /index.html   200
 ```
 
+## ZEIT Now
+
+1. Install [Now CLI](https://zeit.co/download), `npm i -g now`
+2. Change directory to your docsify website, for example `cd docs`
+3. Deploy with a single command, `now` 
+
 ## AWS Amplify
 
 1. Set the routerMode in the Docsify project `index.html` to *history* mode.
@@ -122,10 +128,10 @@ frontend:
 
 ```
 
-6. Add the following Redirect rules in their displayed order.
+6. Add the following Redirect rules in their displayed order. Note that the second record is a PNG image where you can change it with any image format you are using. 
 
 | Source address | Target address | Type          |
 |----------------|----------------|---------------|
 | /<*>.md        | /<*>.md        | 200 (Rewrite) |
+| /<*>.png       | /<*>.png       | 200 (Rewrite) |
 | /<*>           | /index.html    | 200 (Rewrite) |        
-

docs/more-pages.md

@@ -18,9 +18,9 @@ Matching routes
 
 ```text
 docs/README.md        => http://domain.com
-docs/guide.md         => http://domain.com/guide
-docs/zh-cn/README.md  => http://domain.com/zh-cn/
-docs/zh-cn/guide.md   => http://domain.com/zh-cn/guide
+docs/guide.md         => http://domain.com/#/guide
+docs/zh-cn/README.md  => http://domain.com/#/zh-cn/
+docs/zh-cn/guide.md   => http://domain.com/#/zh-cn/guide
 ```
 
 ## Sidebar

docs/themes.md

@@ -1,6 +1,6 @@
 # Themes
 
-There are currently three themes available. Copy [Vue](//vuejs.org) and [buble](//buble.surge.sh) website custom theme and [@liril-net](https://github.com/liril-net) contribution to the theme of the black style.
+There is a handful of themes available, both official and community-made. Copy [Vue](//vuejs.org) and [buble](//buble.surge.sh) website custom theme and [@liril-net](https://github.com/liril-net) contribution to the theme of the black style.
 
 ```html
 <link rel="stylesheet" href="//unpkg.com/docsify/themes/vue.css">