chore(CI): added snyk action

* feat: new option hideSidebar

* chore: removed the console logs

* chore: linting fixes

* chore: test fix

.eslintignore

@@ -4,4 +4,8 @@ node_modules
 build
 server.js
 cypress
-lib
+lib
+themes
+build
+docs/
+**/*.md

.eslintrc

@@ -1,34 +0,0 @@
-{
-  "extends": "xo-space/browser",
-  "rules": {
-    "semi": [
-      2,
-      "never"
-    ],
-    "no-return-assign": "off",
-    "no-unused-expressions": "off",
-    "no-new-func": "off",
-    "no-multi-assign": "off",
-    "no-mixed-operators": "off",
-    "max-params": "off",
-    "no-script-url": "off",
-    "camelcase": "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
-  }
-}

.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/Security.yml

@@ -0,0 +1,20 @@
+name: Security Flow
+
+on: 
+  push:
+   branches:
+    - master
+    - develop
+  pull_request:
+   branches:
+    - master
+    - develop
+jobs:
+  security:
+    runs-on: ubuntu-16.04
+    steps:
+      - uses: actions/checkout@master
+      - name: Run Snyk to check for vulnerabilities
+        uses: snyk/actions/node@master
+        env:
+          SNYK_TOKEN: ${{ secrets.SNYK_TOKEN }}

.github/workflows/e2e.yml

@@ -27,7 +27,5 @@ jobs:
       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

.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

.prettierrc.js

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

.travis.yml

@@ -1,23 +0,0 @@
-sudo: false
-language: node_js
-node_js: stable
-node_js:
-  - '10'
-  - '8'
-  - '12'
-branches:
-  only:
-    - master
-    - develop
-cache:
-  directories:
-    - node_modules
-before_install:
-  - npm update
-install:
-  - npm install
-script:
-  - npm run build
-  - npm run test:e2e
-script:
-  - npm run lint

.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/integration/sidebar/config.spec.js

@@ -1,29 +1,29 @@
 context('sidebar.configurations', () => {
   beforeEach(() => {
-    cy.visit('http://localhost:3000')
-  })
+    cy.visit('http://localhost:3000');
+  });
 
   const quickStartIds = [
     'initialize',
     'writing-content',
     'preview-your-site',
     'manual-initialization',
-    'loading-dialog'
-  ]
+    'loading-dialog',
+  ];
   quickStartIds.forEach(id => {
     it('go to #quickstart?id=' + id, () => {
       cy.get(
         '.sidebar-nav > :nth-child(1) > :nth-child(1) > ul > :nth-child(1) > a'
-      ).click()
+      ).click();
 
       cy.get(`a.section-link[href='#/quickstart?id=${id}']`)
         .click()
         .then(() => {
-          cy.wait(500)
-          cy.matchImageSnapshot()
-        })
-    })
-  })
+          cy.wait(500);
+          cy.matchImageSnapshot();
+        });
+    });
+  });
 
   const configurationIds = [
     'el',
@@ -31,6 +31,7 @@ context('sidebar.configurations', () => {
     'maxlevel',
     'loadnavbar',
     'loadsidebar',
+    'hidesidebar',
     'submaxlevel',
     'auto2top',
     'homepage',
@@ -57,92 +58,92 @@ context('sidebar.configurations', () => {
     'requestheaders',
     'ext',
     'fallbacklanguages',
-    'notfoundpage'
-  ]
+    'notfoundpage',
+  ];
   configurationIds.forEach(id => {
     it('go to #configuration?id=' + id, () => {
-      cy.get('[href="#/configuration"]').click()
+      cy.get('[href="#/configuration"]').click();
 
       cy.get(`a.section-link[href='#/configuration?id=${id}']`)
         .click()
         .then(() => {
-          cy.wait(500) // its more far from the cover
-          cy.matchImageSnapshot()
-        })
-    })
-  })
+          cy.wait(500); // its more far from the cover
+          cy.matchImageSnapshot();
+        });
+    });
+  });
 
   const morePagesIds = [
     'sidebar',
     'nested-sidebars',
     'set-page-titles-from-sidebar-selection',
     'table-of-contents',
-    'ignoring-subheaders'
-  ]
+    'ignoring-subheaders',
+  ];
   morePagesIds.forEach(id => {
     it('go to #more-pages?id=' + id, () => {
-      cy.get('[href="#/more-pages"]').click()
+      cy.get('[href="#/more-pages"]').click();
 
       cy.get(`a.section-link[href='#/more-pages?id=${id}']`)
         .click()
         .then(() => {
-          cy.wait(500)
-          cy.matchImageSnapshot()
-        })
-    })
-  })
+          cy.wait(500);
+          cy.matchImageSnapshot();
+        });
+    });
+  });
 
   const customNavbarIds = [
     'html',
     'markdown',
     'nesting',
-    'combining-custom-navbars-with-the-emoji-plugin'
-  ]
+    'combining-custom-navbars-with-the-emoji-plugin',
+  ];
   customNavbarIds.forEach(id => {
     it('go to #custom-navbar?id=' + id, () => {
-      cy.get('[href="#/custom-navbar"]').click()
+      cy.get('[href="#/custom-navbar"]').click();
 
       cy.get(`a.section-link[href='#/custom-navbar?id=${id}']`)
         .click()
         .then(() => {
-          cy.wait(500)
-          cy.matchImageSnapshot()
-        })
-    })
-  })
+          cy.wait(500);
+          cy.matchImageSnapshot();
+        });
+    });
+  });
 
   const coverIds = [
     'basic-usage',
     'custom-background',
     'coverpage-as-homepage',
-    'multiple-covers'
-  ]
+    'multiple-covers',
+  ];
   coverIds.forEach(id => {
     it('go to #cover?id=' + id, () => {
-      cy.get('[href="#/cover"]').click()
+      cy.get('[href="#/cover"]').click();
 
       cy.get(`a.section-link[href='#/cover?id=${id}']`)
         .click()
         .then(() => {
-          cy.wait(500)
-          cy.matchImageSnapshot()
-        })
-    })
-  })
+          cy.wait(500);
+          cy.matchImageSnapshot();
+        });
+    });
+  });
 
-  const themesIds = ['other-themes']
+  const themesIds = ['other-themes'];
   themesIds.forEach(id => {
     it('go to #themes?id=' + id, () => {
-      cy.get('[href="#/themes"]').click()
+      cy.get('[href="#/themes"]').click();
 
       cy.get(`a.section-link[href='#/themes?id=${id}']`)
         .click()
         .then(() => {
-          cy.wait(500)
-          cy.matchImageSnapshot()
-        })
-    })
-  })
+          cy.wait(500);
+          cy.matchImageSnapshot();
+        });
+    });
+  });
 
   const pluginsIds = [
     'full-text-search',
@@ -158,57 +159,57 @@ context('sidebar.configurations', () => {
     'pagination',
     'codefund',
     'tabs',
-    'more-plugins'
-  ]
+    'more-plugins',
+  ];
   pluginsIds.forEach(id => {
     it('go to #plugins?id=' + id, () => {
-      cy.get('[href="#/plugins"]').click()
+      cy.get('[href="#/plugins"]').click();
 
       cy.get(`a.section-link[href='#/plugins?id=${id}']`)
         .click()
         .then(() => {
-          cy.wait(500)
-          cy.matchImageSnapshot()
-        })
-    })
-  })
+          cy.wait(500);
+          cy.matchImageSnapshot();
+        });
+    });
+  });
 
-  const writeAPluginIds = ['full-configuration', 'example', 'tips']
+  const writeAPluginIds = ['full-configuration', 'example', 'tips'];
   writeAPluginIds.forEach(id => {
     it('go to #write-a-plugin?id=' + id, () => {
-      cy.get('[href="#/write-a-plugin"]').click()
+      cy.get('[href="#/write-a-plugin"]').click();
 
       cy.get(`a.section-link[href='#/write-a-plugin?id=${id}']`)
         .click()
         .then(() => {
-          cy.wait(500)
-          cy.matchImageSnapshot()
-        })
-    })
-  })
+          cy.wait(500);
+          cy.matchImageSnapshot();
+        });
+    });
+  });
 
-  const markdownIds = ['supports-mermaid']
+  const markdownIds = ['supports-mermaid'];
   markdownIds.forEach(id => {
     it('go to #markdown?id=' + id, () => {
-      cy.get('[href="#/markdown"]').click()
+      cy.get('[href="#/markdown"]').click();
 
       cy.get(`a.section-link[href='#/markdown?id=${id}']`)
         .click()
         .then(() => {
-          cy.wait(500)
-          cy.matchImageSnapshot()
-        })
-    })
-  })
+          cy.wait(500);
+          cy.matchImageSnapshot();
+        });
+    });
+  });
 
   it('go to #Language-highlight', () => {
     cy.get('a[href="#/language-highlight"]')
       .click()
       .then(() => {
-        cy.wait(500)
-        cy.matchImageSnapshot()
-      })
-  })
+        cy.wait(500);
+        cy.matchImageSnapshot();
+      });
+  });
 
   // const deployIds = [
   //   'github-pages',
@@ -239,106 +240,105 @@ context('sidebar.configurations', () => {
     'set-target-attribute-for-link',
     'disable-link',
     'github-task-lists',
-    'image-resizing',
     'customise-id-for-headings',
-    'markdown-in-html-tag'
-  ]
+    'markdown-in-html-tag',
+  ];
   helpersIds.forEach(id => {
     it('go to #helpers?id=' + id, () => {
-      cy.get('[href="#/helpers"]').click()
+      cy.get('[href="#/helpers"]').click();
 
       cy.get(`a.section-link[href='#/helpers?id=${id}']`)
         .click()
         .then(() => {
-          cy.wait(500)
-          cy.matchImageSnapshot()
-        })
-    })
-  })
+          cy.wait(500);
+          cy.matchImageSnapshot();
+        });
+    });
+  });
 
-  const vueIds = ['basic-usage', 'combine-vuep-to-write-playground']
+  const vueIds = ['basic-usage', 'combine-vuep-to-write-playground'];
   vueIds.forEach(id => {
     it('go to #vue?id=' + id, () => {
-      cy.get('[href="#/vue"]').click()
+      cy.get('[href="#/vue"]').click();
 
       cy.get(`a.section-link[href='#/vue?id=${id}']`)
         .click()
         .then(() => {
-          cy.wait(500)
-          cy.matchImageSnapshot()
-        })
-    })
-  })
+          cy.wait(500);
+          cy.matchImageSnapshot();
+        });
+    });
+  });
 
   const cdnIds = [
     'latest-version',
     'specific-version',
     'compressed-file',
-    'other-cdn'
-  ]
+    'other-cdn',
+  ];
   cdnIds.forEach(id => {
     it('go to #cdn?id=' + id, () => {
-      cy.get('[href="#/cdn"]').click()
+      cy.get('[href="#/cdn"]').click();
 
       cy.get(`a.section-link[href='#/cdn?id=${id}']`)
         .click()
         .then(() => {
-          cy.wait(500)
-          cy.matchImageSnapshot()
-        })
-    })
-  })
+          cy.wait(500);
+          cy.matchImageSnapshot();
+        });
+    });
+  });
 
-  const pwaIds = ['create-serviceworker', 'register', 'enjoy-it']
+  const pwaIds = ['create-serviceworker', 'register', 'enjoy-it'];
   pwaIds.forEach(id => {
     it('go to #pwa?id=' + id, () => {
-      cy.get('[href="#/pwa"]').click()
+      cy.get('[href="#/pwa"]').click();
 
       cy.get(`a.section-link[href='#/pwa?id=${id}']`)
         .click()
         .then(() => {
-          cy.wait(500)
-          cy.matchImageSnapshot()
-        })
-    })
-  })
+          cy.wait(500);
+          cy.matchImageSnapshot();
+        });
+    });
+  });
 
   const ssrIds = [
     'why-ssr',
     'quick-start',
     'custom-template',
     'configuration',
-    'deploy-for-your-vps'
-  ]
+    'deploy-for-your-vps',
+  ];
 
   ssrIds.forEach(id => {
     it('go to #ssr?id=' + id, () => {
-      cy.get('[href="#/ssr"]').click()
+      cy.get('[href="#/ssr"]').click();
 
       cy.get(`a.section-link[href='#/ssr?id=${id}']`)
         .click()
         .then(() => {
-          cy.wait(500)
-          cy.matchImageSnapshot()
-        })
-    })
-  })
+          cy.wait(500);
+          cy.matchImageSnapshot();
+        });
+    });
+  });
   const embedFilesIds = [
     'embedded-file-type',
     'embedded-code-fragments',
     'tag-attribute',
-    'the-code-block-highlight'
-  ]
+    'the-code-block-highlight',
+  ];
   embedFilesIds.forEach(id => {
     it('go to #embed-files?id=' + id, () => {
-      cy.get('[href="#/embed-files"]').click()
+      cy.get('[href="#/embed-files"]').click();
 
       cy.get(`a.section-link[href='#/embed-files?id=${id}']`)
         .click()
         .then(() => {
-          cy.wait(500)
-          cy.matchImageSnapshot()
-        })
-    })
-  })
-})
+          cy.wait(500);
+          cy.matchImageSnapshot();
+        });
+    });
+  });
+});