Skip to content
Permalink

Comparing changes

Choose two branches to see what’s changed or to start a new pull request. If you need to, you can also or learn more about diff comparisons.

Open a pull request

Create a new pull request by comparing changes across two branches. If you need to, you can also . Learn more about diff comparisons here.
base repository: docsifyjs/docsify
Failed to load repositories. Confirm that selected base ref is valid, then try again.
Loading
base: v4.8.2
Choose a base ref
...
head repository: docsifyjs/docsify
Failed to load repositories. Confirm that selected head ref is valid, then try again.
Loading
compare: master
Choose a head ref

Commits on Nov 1, 2018

  1. Copy the full SHA
    6daecc8 View commit details
  2. Copy the full SHA
    ee800a6 View commit details
  3. [build] 4.8.3

    QingWei-Li committed Nov 1, 2018
    Copy the full SHA
    58b1309 View commit details
  4. Copy the full SHA
    d91a66c View commit details
  5. chore: update changelog

    QingWei-Li committed Nov 1, 2018
    Copy the full SHA
    81ec7c7 View commit details
  6. fix(cover): Compatible with legacy styles, fixed #677 (#678)

    Please makes sure these boxes are checked before submitting your PR, thank you!
    
    * [ ] Make sure you are merging your commits to `master` branch.
    * [ ] Add some descriptions and refer relative issues for you PR.
    * [ ] DO NOT include files inside `lib` directory.
    QingWei-Li authored Nov 1, 2018
    Copy the full SHA
    1a945d4 View commit details
  7. [build] 4.8.4

    QingWei-Li committed Nov 1, 2018
    Copy the full SHA
    f84242d View commit details
  8. Copy the full SHA
    5ab9d8c View commit details
  9. Copy the full SHA
    22a5927 View commit details

Commits on Nov 2, 2018

  1. 1
    Copy the full SHA
    aa719e3 View commit details
  2. [build] 4.8.5

    QingWei-Li committed Nov 2, 2018
    Copy the full SHA
    5b6525b View commit details
  3. Copy the full SHA
    cc79e2e View commit details

Commits on Nov 6, 2018

  1. docs: mermaid duplicated id, see #504 (#685)

    Please makes sure these boxes are checked before submitting your PR, thank you!
    
    * [x] Make sure you are merging your commits to `master` branch.
    * [x] Add some descriptions and refer relative issues for you PR.
    * [x] DO NOT include files inside `lib` directory.
    upupming authored and QingWei-Li committed Nov 6, 2018
    1
    Copy the full SHA
    a72e749 View commit details

Commits on Nov 12, 2018

  1. fix: IE10 compatibility (#691)

    * fix: IE10 compatibility
    
    * chore: use built-in helper fn
    cheng-kang authored and QingWei-Li committed Nov 12, 2018
    Copy the full SHA
    4db8cd6 View commit details
  2. [build] 4.8.6

    QingWei-Li committed Nov 12, 2018
    Copy the full SHA
    a07a613 View commit details
  3. chore: add changelog 4.8.6

    QingWei-Li committed Nov 12, 2018
    Copy the full SHA
    a257a4a View commit details

Commits on Nov 27, 2018

  1. fix: upgrade npm-run-all

    QingWei-Li committed Nov 27, 2018
    Copy the full SHA
    049726e View commit details

Commits on Dec 5, 2018

  1. feat(search-plugin): add namespace option (#706)

    * feat(search-plugin): add namespace option
    
    * docs(search-plugin): update doc for option namespace
    cheng-kang authored and QingWei-Li committed Dec 5, 2018
    Copy the full SHA
    28beff8 View commit details
  2. Fix getAndRemoveConfig regex (#708)

    * Fix getAndRemoveConfig regex
    
    Update getAndRemoveConfig regular expression for prevent cases, when header has name like "foo::bar::baz".
    
    * Fix wrong regexp
    
    * Fix regex
    
    Ignore `:foo` cases
    bashkirtsevich authored and QingWei-Li committed Dec 5, 2018
    Copy the full SHA
    6ac7bac View commit details

Commits on Jan 5, 2019

  1. Copy the full SHA
    99dbaa3 View commit details
  2. Copy the full SHA
    3b952ac View commit details

Commits on Jan 23, 2019

  1. Copy the full SHA
    1447c8a View commit details
  2. feat: Add new theme "dolphin" (#735)

    Dolphin is a blue theme based on the theme vue, using the font Thasadith -- https://fonts.google.com/specimen/Thasadith as default.
    Andy Chen authored and QingWei-Li committed Jan 23, 2019
    Copy the full SHA
    c3345ba View commit details

Commits on Jan 30, 2019

  1. fix: task list rendering (Fix #749) (#757)

    This PR restores the task list presentation removed in 4.8:
    
    - Add “task-list-item” class to task list `<li>` elms
    - Hide list bullets on unordered task lists `<li>` elms
    
    It also provides several improvements on the pre-4.8 presentation:
    
    - Add “task-list” class to task list `<ul>` elms 
    - Display list numbers on ordered task lists `<li>` elms
    - Render accessible task list items by wrapping checkbox and text in `<label>` elm
    - Allow task lists to be nested within standard ordered/unordered lists 
    
    Please makes sure these boxes are checked before submitting your PR, thank you!
    
    * [x] Make sure you are merging your commits to `master` branch.
    * [x] Add some descriptions and refer relative issues for you PR.
    * [x] DO NOT include files inside `lib` directory.
    jhildenbiddle authored and QingWei-Li committed Jan 30, 2019
    Copy the full SHA
    69ef489 View commit details
  2. Copy the full SHA
    fd86c72 View commit details

Commits on Feb 5, 2019

  1. Merge pull request #737 from jthegedus/ssr-now-fix

    Fix typo in Now SSR example code snippet
    timaschew authored Feb 5, 2019
    Copy the full SHA
    cb53106 View commit details

Commits on Feb 14, 2019

  1. Copy the full SHA
    b535718 View commit details
  2. Merge pull request #760 from docsifyjs/provide-tests

    Setup test environment and provide the first test
    timaschew authored Feb 14, 2019
    Copy the full SHA
    8cd786c View commit details

Commits on Feb 19, 2019

  1. [build] 4.9.0

    QingWei-Li committed Feb 19, 2019
    Copy the full SHA
    d1c7268 View commit details
  2. chore: add changelog 4.9.0

    QingWei-Li committed Feb 19, 2019
    Copy the full SHA
    dfd31b5 View commit details

Commits on Feb 21, 2019

  1. fix: github assets url (#774)

    louislivi authored and QingWei-Li committed Feb 21, 2019
    Copy the full SHA
    140bf10 View commit details
  2. [build] 4.9.1

    QingWei-Li committed Feb 21, 2019
    Copy the full SHA
    29d9cda View commit details
  3. chore: add changelog 4.9.1

    QingWei-Li committed Feb 21, 2019
    Copy the full SHA
    bc4d06b View commit details

Commits on Feb 25, 2019

  1. Copy the full SHA
    11ea1f8 View commit details
  2. fix xhr usage, fix init URL setup

    provide full test setup including fixtures
    devtonhere committed Feb 25, 2019
    Copy the full SHA
    01ea441 View commit details
  3. split test into unit and integration

    provide some dummy tests cases
    devtonhere committed Feb 25, 2019
    Copy the full SHA
    dac0bfe View commit details
  4. Fixed iframe overflow bug for mobile Safari (#782)

    Fixed iframe overflow bug for mobile Safari
    trevoreyre authored and timaschew committed Feb 25, 2019
    Copy the full SHA
    a355319 View commit details

Commits on Mar 3, 2019

  1. Merge pull request #784 from spiritree/hotfix/gitalk

    fix: re-render gitalk when router changed
    timaschew authored Mar 3, 2019
    Copy the full SHA
    d5910bd View commit details

Commits on Mar 6, 2019

  1. rework TODOs

    timaschew committed Mar 6, 2019
    Copy the full SHA
    2039e0d View commit details

Commits on Mar 8, 2019

  1. Merge pull request #776 from docsifyjs/improve-test-setup

    Improve test setup
    timaschew authored Mar 8, 2019
    Copy the full SHA
    c1d4961 View commit details

Commits on Mar 13, 2019

  1. Docsify publishing with AWS Amplify steps

    This is to help users be able to publish Docsify with AWS Amplify, so they don't get stuck on redirect rules and hash state issues.
    gemmadlou authored Mar 13, 2019
    Copy the full SHA
    21cde83 View commit details

Commits on Mar 15, 2019

  1. Merge pull request #792 from gemmadlou/master

    Docsify publishing with AWS Amplify steps
    timaschew authored Mar 15, 2019
    Copy the full SHA
    d80aa21 View commit details

Commits on Mar 25, 2019

  1. feat: allows relative path, fixed #590

    Sylvain Brocard committed Mar 25, 2019
    Copy the full SHA
    31654f1 View commit details
  2. IE compatibility and add unit tests

    Sylvain Brocard committed Mar 25, 2019
    Copy the full SHA
    ca8ae50 View commit details

Commits on Apr 5, 2019

  1. Fix typo in Edit Button example

    Missing trailing slash in the Edit button url
    cyrilf authored Apr 5, 2019
    Copy the full SHA
    24e61f5 View commit details
  2. Merge pull request #807 from cyrilf/patch-1

    Fix typo in edit button example
    timaschew authored Apr 5, 2019
    Copy the full SHA
    270fa6c View commit details

Commits on Apr 7, 2019

  1. Merge pull request #714 from ENOVACOM/relative-path

    feat: allows relative path, fixed #590
    timaschew authored Apr 7, 2019
    Copy the full SHA
    bba44fb View commit details

Commits on Apr 8, 2019

  1. Merge pull request #733 from jthegedus/master

    document customising page title with sidebar
    timaschew authored Apr 8, 2019
    Copy the full SHA
    f74b53f View commit details

Commits on Apr 13, 2019

  1. Update GitHub templates

    timaschew committed Apr 13, 2019
    Copy the full SHA
    09616de View commit details
  2. Merge pull request #817 from docsifyjs/update-github-templates

    Update GitHub templates
    timaschew authored Apr 13, 2019
    Copy the full SHA
    4e02980 View commit details
Showing with 55,903 additions and 16,122 deletions.
  1. +5 −0 .codesandbox/ci.json
  2. +11 −0 .editorconfig
  3. +7 −3 .eslintignore
  4. +0 −20 .eslintrc
  5. +84 −0 .eslintrc.js
  6. +2 −0 .github/FUNDING.yml
  7. +0 −2 .github/ISSUE_TEMPLATE.md
  8. +45 −0 .github/ISSUE_TEMPLATE/bug_report.md
  9. +5 −0 .github/ISSUE_TEMPLATE/config.yml
  10. +25 −0 .github/ISSUE_TEMPLATE/feature_request.md
  11. +64 −4 .github/PULL_REQUEST_TEMPLATE.md
  12. +4 −0 .github/semantic.yml
  13. +79 −0 .github/workflows/test.yml
  14. +9 −5 .gitignore
  15. +10 −0 .gitpod.yml
  16. +1 −1 .npmignore
  17. +4 −0 .prettierrc.js
  18. +0 −3 .travis.yml
  19. +73 −0 .vscode/launch.json
  20. +2 −1 .vscode/settings.json
  21. +509 −164 CHANGELOG.md
  22. +2 −2 CONTRIBUTING.md
  23. +9 −0 Dockerfile
  24. +1 −1 LICENSE
  25. +30 −11 README.md
  26. +23 −0 SECURITY.md
  27. +12 −0 babel.config.js
  28. +90 −52 build/build.js
  29. +47 −0 build/css.js
  30. +109 −0 build/emoji.js
  31. +3 −0 build/mincss.js
  32. +3 −2 build/release.sh
  33. +2 −1 build/ssr.js
  34. +5 −5 docs/README.md
  35. +2 −2 docs/_coverpage.md
  36. +6 −0 docs/_media/example-with-yaml.md
  37. +16 −0 docs/_media/example.js
  38. +6 −0 docs/_media/powered-by-vercel.svg
  39. +1 −0 docs/_media/vercel_logo.svg
  40. +3 −3 docs/_navbar.md
  41. +3 −2 docs/_sidebar.md
  42. +11 −11 docs/cdn.md
  43. +611 −185 docs/configuration.md
  44. +3 −5 docs/cover.md
  45. +4 −4 docs/custom-navbar.md
  46. +107 −13 docs/deploy.md
  47. +117 −7 docs/embed-files.md
  48. +3,765 −0 docs/emoji.md
  49. +68 −8 docs/helpers.md
  50. +217 −91 docs/index.html
  51. +58 −6 docs/language-highlight.md
  52. +4 −3 docs/markdown.md
  53. +34 −12 docs/more-pages.md
  54. +64 −47 docs/plugins.md
  55. +5 −5 docs/pwa.md
  56. +59 −29 docs/quickstart.md
  57. +20 −13 docs/ssr.md
  58. +15 −11 docs/themes.md
  59. +306 −59 docs/vue.md
  60. +210 −55 docs/write-a-plugin.md
  61. +118 −61 index.html
  62. +29 −0 jest.config.js
  63. +0 −4,854 lib/docsify.js
  64. +0 −1 lib/docsify.min.js
  65. +0 −54 lib/plugins/disqus.js
  66. +0 −1 lib/plugins/disqus.min.js
  67. +0 −903 lib/plugins/emoji.js
  68. +0 −1 lib/plugins/emoji.min.js
  69. +0 −28 lib/plugins/external-script.js
  70. +0 −1 lib/plugins/external-script.min.js
  71. +0 −496 lib/plugins/front-matter.js
  72. +0 −1 lib/plugins/front-matter.min.js
  73. +0 −41 lib/plugins/ga.js
  74. +0 −1 lib/plugins/ga.min.js
  75. +0 −20 lib/plugins/gitalk.js
  76. +0 −1 lib/plugins/gitalk.min.js
  77. +0 −346 lib/plugins/search.js
  78. +0 −1 lib/plugins/search.min.js
  79. +0 −40 lib/plugins/zoom-image.js
  80. +0 −1 lib/plugins/zoom-image.min.js
  81. +0 −1 lib/themes/buble.css
  82. +0 −1 lib/themes/dark.css
  83. +0 −1 lib/themes/pure.css
  84. +0 −1 lib/themes/vue.css
  85. +39,749 −5,713 package-lock.json
  86. +86 −42 package.json
  87. +4 −4 packages/docsify-server-renderer/README.md
  88. +113 −82 packages/docsify-server-renderer/index.js
  89. +264 −27 packages/docsify-server-renderer/package-lock.json
  90. +5 −5 packages/docsify-server-renderer/package.json
  91. +64 −0 playwright.config.js
  92. +4 −0 sandbox.config.json
  93. +1 −1 server.js
  94. +53 −0 src/core/Docsify.js
  95. +59 −42 src/core/config.js
  96. +44 −21 src/core/event/index.js
  97. +95 −76 src/core/event/scroll.js
  98. +60 −39 src/core/event/sidebar.js
  99. +35 −31 src/core/fetch/ajax.js
  100. +223 −179 src/core/fetch/index.js
  101. +21 −11 src/core/global-api.js
  102. +4 −42 src/core/index.js
  103. +0 −27 src/core/init/index.js
  104. +77 −41 src/core/init/lifecycle.js
  105. +211 −231 src/core/render/compiler.js
  106. +15 −0 src/core/render/compiler/code.js
  107. +39 −0 src/core/render/compiler/headline.js
  108. +48 −0 src/core/render/compiler/image.js
  109. +64 −0 src/core/render/compiler/link.js
  110. +15 −0 src/core/render/compiler/paragraph.js
  111. +16 −0 src/core/render/compiler/taskList.js
  112. +9 −0 src/core/render/compiler/taskListItem.js
  113. +94 −49 src/core/render/embed.js
  114. +1,888 −0 src/core/render/emoji-data.js
  115. +45 −8 src/core/render/emojify.js
  116. +15 −13 src/core/render/gen-tree.js
  117. +390 −208 src/core/render/index.js
  118. +21 −19 src/core/render/progressbar.js
  119. +14 −14 src/core/render/slugify.js
  120. +45 −37 src/core/render/tpl.js
  121. +50 −0 src/core/render/utils.js
  122. +10 −10 src/core/router/history/abstract.js
  123. +45 −33 src/core/router/history/base.js
  124. +60 −30 src/core/router/history/hash.js
  125. +30 −28 src/core/router/history/html5.js
  126. +57 −35 src/core/router/index.js
  127. +81 −28 src/core/router/util.js
  128. +60 −15 src/core/util/core.js
  129. +56 −29 src/core/util/dom.js
  130. +4 −4 src/core/util/env.js
  131. +3 −3 src/core/util/index.js
  132. +12 −12 src/core/util/polyfill/css-vars.js
  133. +16 −0 src/core/util/str.js
  134. +21 −0 src/core/virtual-routes/exact-match.js
  135. +93 −0 src/core/virtual-routes/index.js
  136. +21 −0 src/core/virtual-routes/next.js
  137. +29 −28 src/plugins/disqus.js
  138. +11 −898 src/plugins/emoji.js
  139. +12 −12 src/plugins/external-script.js
  140. +15 −7 src/plugins/front-matter/index.js
  141. +19 −17 src/plugins/ga.js
  142. +19 −12 src/plugins/gitalk.js
  143. +39 −0 src/plugins/matomo.js
  144. +92 −67 src/plugins/search/component.js
  145. +28 −22 src/plugins/search/index.js
  146. +224 −101 src/plugins/search/search.js
  147. +18 −9 src/plugins/zoom-image.js
  148. +12 −5 src/themes/basic/_coverpage.styl
  149. +26 −4 src/themes/basic/_layout.styl
  150. +11 −4 src/themes/buble.styl
  151. +10 −1 src/themes/dark.styl
  152. +237 −0 src/themes/dolphin.styl
  153. +76 −42 src/themes/vue.styl
  154. +70 −0 test/README.md
  155. +85 −0 test/config/jest.setup-tests.js
  156. +5 −0 test/config/jest.setup.js
  157. +5 −0 test/config/jest.teardown.js
  158. +5 −0 test/config/playwright.setup.js
  159. +5 −0 test/config/playwright.teardown.js
  160. +123 −0 test/config/server.js
  161. +3 −0 test/e2e/.eslintrc.js
  162. +67 −0 test/e2e/configuration.test.js
  163. +302 −0 test/e2e/example.test.js
  164. +16 −0 test/e2e/fixtures/docsify-init-fixture.js
  165. +28 −0 test/e2e/index-file.test.js
  166. +155 −0 test/e2e/plugins.test.js
  167. +199 −0 test/e2e/search.test.js
  168. +34 −0 test/e2e/security.test.js
  169. +71 −0 test/e2e/sidebar.test.js
  170. +293 −0 test/e2e/virtual-routes.test.js
  171. +218 −0 test/e2e/vue.test.js
  172. +361 −0 test/helpers/docsify-init.js
  173. +132 −0 test/helpers/wait-for.js
  174. +1 −0 test/integration/.eslintrc.js
  175. +12 −0 test/integration/__snapshots__/docs.test.js.snap
  176. +31 −0 test/integration/__snapshots__/emoji.test.js.snap
  177. +66 −0 test/integration/docs.test.js
  178. +52 −0 test/integration/docsify.test.js
  179. +187 −0 test/integration/emoji.test.js
  180. +150 −0 test/integration/example.test.js
  181. +21 −0 test/integration/global-apis.test.js
  182. +267 −0 test/integration/render.test.js
  183. +7 −0 test/unit/.eslintrc.js
  184. +3 −0 test/unit/__snapshots__/example.test.js.snap
  185. +75 −0 test/unit/core-util.test.js
  186. +119 −0 test/unit/example.test.js
  187. +6 −0 test/unit/fixtures/get-time-of-day.js
  188. +7 −0 test/unit/fixtures/greet.js
  189. +102 −0 test/unit/render-util.test.js
  190. +69 −0 test/unit/router-history-base.test.js
  191. +27 −0 test/unit/router-util.test.js
5 changes: 5 additions & 0 deletions .codesandbox/ci.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"sandboxes": ["2d17z"],
"packages": [".", "packages/docsify-server-renderer"],
"node": "16"
}
11 changes: 11 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -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
10 changes: 7 additions & 3 deletions .eslintignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
.git
packages/docsify-server-renderer/build.js
node_modules
**/*.md
build
server.js
docs
lib
node_modules
packages/docsify-server-renderer/build.js
server.js
themes
20 changes: 0 additions & 20 deletions .eslintrc

This file was deleted.

84 changes: 84 additions & 0 deletions .eslintrc.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
const prettierConfig = require('./.prettierrc');

module.exports = {
root: true,
extends: [
'eslint:recommended',
'plugin:import/recommended',
'plugin:prettier/recommended', // Must be last
],
parser: '@babel/eslint-parser',
parserOptions: {
sourceType: 'module',
ecmaVersion: 2019,
},
plugins: ['prettier', 'import'],
env: {
browser: true,
es6: true,
node: true,
},
settings: {
'import/ignore': ['node_modules', '.json$'],
},
rules: {
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-restricted-names': ['error'],
'no-shadow': [
'error',
{
allow: [
'Events',
'Fetch',
'Lifecycle',
'Render',
'Router',
'VirtualRoutes',
],
},
],
'no-unused-vars': ['error', { args: 'none' }],
'no-useless-call': ['error'],
'no-useless-escape': ['warn'],
'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/imports-first': ['error'],
'import/newline-after-import': ['error'],
'import/no-duplicates': ['error'],
'import/no-mutable-exports': ['error'],
'import/no-named-as-default-member': ['error'],
'import/no-named-as-default': ['error'],
'import/no-unresolved': 'off',
'import/order': ['warn'],

// Prettier (Must be last)
'prettier/prettier': ['warn', prettierConfig],
},
globals: {
$docsify: 'writable',
Docsify: 'writable',
dom: 'writable',
},
};
2 changes: 2 additions & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
open_collective: docsify

2 changes: 0 additions & 2 deletions .github/ISSUE_TEMPLATE.md

This file was deleted.

45 changes: 45 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
---
name: Bug report
about: Create a report to help us improve

---
<!-- Please don't delete this template or we'll close your issue -->
<!-- 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 Discord: https://discord.gg/3NwKFyR -->

## Bug Report

#### Steps to reproduce



#### What is current behaviour



#### What is the expected behaviour



#### Other relevant information

<!-- (Update "[ ]" to "[x]" to check a box) -->
- [ ] Bug does still occur when all/other plugins are disabled?

- Your OS:
- Node.js version:
- npm/yarn version:
- Browser version:
- Docsify version:
- Docsify plugins:

<!-- 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)
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: Discord - the community chat
url: https://discord.gg/3NwKFyR
about: Join Discord community and chat about Docsify
25 changes: 25 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
name: Feature request
about: Suggest an idea for this project

---
<!-- Please don't delete this template or we'll close your issue -->
<!-- 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 -->

## Feature request

#### What problem does this feature solve?



#### What does the proposed API look like?



#### How should this be implemented in your opinion?



#### Are you willing to work on this yourself?
68 changes: 64 additions & 4 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,65 @@
Please makes sure these boxes are checked before submitting your PR, thank you!
<!--
PULL REQUEST TEMPLATE
---
Please use English language
Please don't delete this template
---
Update "[ ]" to "[x]" to check a box in any list below.
---
To avoid wasting your time, it's best to open a **feature request issue** first and wait for approval before working on it.
-->

* [ ] Make sure you are merging your commits to `master` branch.
* [ ] Add some descriptions and refer relative issues for you PR.
* [ ] DO NOT include files inside `lib` directory.
## **Summary**

<!--
THIS IS REQUIRED! Please describe what the change does and why it should be merged.
-->

<!--
If changing the UI in any way, please provide the a **before/after** screenshot:
-->

## **What kind of change does this PR introduce?**

<!--
Copy/paste one of the following options:
-->

<!--
Bugfix
Feature
Code style update
Refactor
Docs
Build-related changes
Repo settings
Other
-->

<!--
If you chose Other, please describe.
-->

## **For any code change,**

- [ ] Related documentation has been updated if needed
- [ ] Related tests have been updated or tests have been added

## **Does this PR introduce a breaking change?** (check one)

- [ ] Yes
- [ ] No

If yes, please describe the impact and migration path for existing applications:

## **Related issue, if any:**

<!-- Paste issue's link or number hashtag here. -->

## **Tested in the following browsers:**

- [ ] Chrome
- [ ] Firefox
- [ ] Safari
- [ ] Edge
- [ ] IE
4 changes: 4 additions & 0 deletions .github/semantic.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
titleAndCommits: true
allowMergeCommits: true
allowRevertCommits: true
anyCommit: true
79 changes: 79 additions & 0 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
name: Build & Test

on:
push:
branches: [master, develop]
pull_request:
branches: [master, develop]

jobs:
lint:
runs-on: ubuntu-latest
strategy:
matrix:
node-version: ['lts/*']
steps:
- uses: actions/checkout@v2
- name: Setup Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v2
with:
node-version: ${{ matrix.node-version }}
cache: 'npm'
- name: Install dependencies
run: npm ci --ignore-scripts
- name: Build
run: npm run build
- name: Lint
run: npm run lint

test-jest:
runs-on: ${{ matrix.os }}
strategy:
fail-fast: false
matrix:
node-version: ['lts/*']
os: ['macos-latest', 'ubuntu-latest', 'windows-latest']
steps:
- uses: actions/checkout@v2
- name: Setup Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v2
with:
node-version: ${{ matrix.node-version }}
cache: 'npm'
- name: Install dependencies
run: npm ci --ignore-scripts
- name: Build
run: npm run build
- name: Unit Tests
run: npm run test:unit -- --ci --runInBand
- name: Integration Tests
run: npm run test:integration -- --ci --runInBand

test-playwright:
runs-on: ubuntu-latest
strategy:
matrix:
node-version: ['lts/*']
steps:
- uses: actions/checkout@v2
- name: Setup Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v2
with:
node-version: ${{ matrix.node-version }}
cache: 'npm'
- name: Install dependencies
run: npm ci --ignore-scripts
- name: Build
run: npm run build
- name: Install Playwright
run: npx playwright install --with-deps
- name: E2E Tests (Playwright)
run: npm run test:e2e
- name: Store artifacts
uses: actions/upload-artifact@v2
if: failure()
with:
name: ${{ matrix.os }}-${{ matrix.node-version }}-artifacts
path: |
_playwright-results/
_playwright-report/
14 changes: 9 additions & 5 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,7 +1,11 @@
*.log
.DS_Store
/themes/*
.idea
*.log
/_playwright-report
/_playwright-results
/lib
/node_modules
/themes

# exceptions
!.gitkeep
node_modules
/lib/
.idea
Loading