docsifyjs · Opt-SCon · Oct 27, 2022 · Oct 28, 2022 · Nov 1, 2022 · Nov 10, 2022
diff --git a/.codesandbox/ci.json b/.codesandbox/ci.json
diff --git a/.eslintignore b/.eslintignore
@@ -4,6 +4,5 @@ build
 docs
 lib
 node_modules
-packages/docsify-server-renderer/build.js
 server.js
 themes
diff --git a/.eslintrc.js → .eslintrc.cjs b/.eslintrc.js → .eslintrc.cjs
@@ -1,4 +1,4 @@
-const prettierConfig = require('./.prettierrc');
+const prettierConfig = require('./.prettierrc.json');
 
 module.exports = {
   root: true,
@@ -63,7 +63,6 @@ module.exports = {
     yoda: ['error', 'never'],
 
     // Import rules
-    // Search way how integrate with `lerna`
     'import/imports-first': ['error'],
     'import/newline-after-import': ['error'],
     'import/no-duplicates': ['error'],

diff --git a/.gitattributes b/.gitattributes
@@ -0,0 +1 @@
+* text=auto eol=lf
diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -1,44 +1,53 @@
 ---
 name: Bug report
-about: Create a report to help us improve
-
+about: Create a report to help us fix an issue
 ---
-<!-- 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 -->
+
+<!--
+Please don't delete this template or we'll close your issue.
+Please write in English.
+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)
+or in our Discord chat server (👉 https://discord.gg/docsify).
+-->
 
 ## Bug Report
 
 #### Steps to reproduce
 
+<!-- List the steps needed to reproduce here. -->
+
+#### Current behaviour
 
+<!-- Describe the current behavior here. -->
 
-#### What is current behaviour
+#### Expected behaviour
 
+<!-- Describe the expected behavior here. -->
 
+#### Other relevant information
 
-#### What is the expected behaviour
+- Docsify version:
 
+<!-- (Change "[ ]" to "[x]" to check a box.) -->
 
+- [ ] Bug still occurs when all/other plugins are disabled?
 
-#### Other relevant information
+- Docsify plugins (if the bug happens when plugins enabled, please try to isolate the issue):
+
+<!-- Please provide the following information if relevant to the issue.
 
-<!-- (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:
 
-- 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 -->
+<!-- Love docsify and want to help us advance Docsify or to spend time supporting your case? Please consider supporting our collective:
+👉 https://opencollective.com/docsify/donate -->
 
-#### Please create a reproducible sandbox 
+#### Please create a reproducible sandbox
 
 [![Edit 307qqv236](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/307qqv236)
 

diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
@@ -1,5 +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
+    url: https://discord.gg/docsify
+    about: Join the Discord community and chat about Docsify
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -1,25 +1,32 @@
 ---
 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?
 
+<!--
+Please don't delete this template or we'll close your issue.
+Please write in English.
+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)
+or in our Discord chat server (👉 https://discord.gg/docsify).
+-->
 
+## Feature request
 
-#### What does the proposed API look like?
+#### Problem or desire
 
+<!-- Describe what problem this feature will solve. -->
 
+#### Proposal
 
-#### How should this be implemented in your opinion?
+<!-- What does the proposed feature look like? -->
 
+#### Implementation
 
+<!--
+How should the feature be implemented in your opinion?
 
-#### Are you willing to work on this yourself?
+We have limited free time. Please consider contributing, or donating to our
+OpenCollective (👉 https://opencollective.com/docsify/donate), to help get this
+feature added and to advance Docsify.
+ -->
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -1,31 +1,25 @@
 <!--
-  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.
+  Please write in English.
+  Please follow the template, all sections are required.
+  Consider opening a feature request first to get your change idea approved.
 -->
 
-## **Summary**
+## Summary
 
 <!--
- THIS IS REQUIRED! Please describe what the change does and why it should be merged.
+Describe what the change does and why it should be merged.
+Provide **before/after** screenshots for any UI changes.
 -->
 
-<!--
-  If changing the UI in any way, please provide the a **before/after** screenshot:
--->
+## Related issue, if any:
 
-## **What kind of change does this PR introduce?**
+<!-- Paste issue's link or number hashtag here. -->
 
-<!--
-  Copy/paste one of the following options:
--->
+## What kind of change does this PR introduce?
 
 <!--
+  Copy/paste any of the relevant following options:
+
   Bugfix
   Feature
   Code style update
@@ -34,32 +28,29 @@
   Build-related changes
   Repo settings
   Other
--->
 
-<!--
-  If you chose Other, please describe.
+  If you choose Other, describe it.
 -->
 
-## **For any code change,**
+## For any code change,
 
-- [ ] Related documentation has been updated if needed
-- [ ] Related tests have been updated or tests have been added
+<!-- (Change "[ ]" to "[x]" to check a box.) -->
 
-## **Does this PR introduce a breaking change?** (check one)
+- [ ] Related documentation has been updated, if needed
+- [ ] Related tests have been added or updated, if needed
 
-- [ ] Yes
-- [ ] No
+## Does this PR introduce a breaking change?
 
-If yes, please describe the impact and migration path for existing applications:
+<!-- (pick one) -->
 
-## **Related issue, if any:**
+Yes
+No
 
-<!-- Paste issue's link or number hashtag here. -->
+<!-- If yes, describe the impact and migration path for existing applications. -->
 
-## **Tested in the following browsers:**
+## Tested in the following browsers:
 
 - [ ] Chrome
 - [ ] Firefox
 - [ ] Safari
 - [ ] Edge
-- [ ] IE
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -0,0 +1,27 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: npm # See documentation for possible values
+    directory: '/' # Location of package manifests
+    open-pull-requests-limit: 10
+    schedule:
+      interval: monthly
+    ignore:
+      # For all dependencies, trigger pull requests only for semver-major updates (ignore minor and patch).
+      - dependency-name: '*'
+        update-types:
+          ['version-update:semver-patch', 'version-update:semver-minor']
+  - package-ecosystem: 'github-actions'
+    directory: '/'
+    open-pull-requests-limit: 10
+    schedule:
+      interval: monthly
+    ignore:
+      # For all dependencies, trigger pull requests only for semver-major and semver-minor updates (ignore patch).
+      - dependency-name: '*'
+        update-types:
+          ['version-update:semver-patch', 'version-update:semver-minor']
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -1,10 +1,6 @@
 name: Build & Test
 
-on:
-  push:
-    branches: [master, develop]
-  pull_request:
-    branches: [master, develop]
+on: [push]
 
 jobs:
   lint:
@@ -13,9 +9,9 @@ jobs:
       matrix:
         node-version: ['lts/*']
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Setup Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v2
+        uses: actions/setup-node@v3
         with:
           node-version: ${{ matrix.node-version }}
           cache: 'npm'
@@ -34,9 +30,9 @@ jobs:
         node-version: ['lts/*']
         os: ['macos-latest', 'ubuntu-latest', 'windows-latest']
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Setup Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v2
+        uses: actions/setup-node@v3
         with:
           node-version: ${{ matrix.node-version }}
           cache: 'npm'
@@ -55,9 +51,9 @@ jobs:
       matrix:
         node-version: ['lts/*']
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Setup Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v2
+        uses: actions/setup-node@v3
         with:
           node-version: ${{ matrix.node-version }}
           cache: 'npm'
@@ -70,7 +66,7 @@ jobs:
       - name: E2E Tests (Playwright)
         run: npm run test:e2e
       - name: Store artifacts
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v4
         if: failure()
         with:
           name: ${{ matrix.os }}-${{ matrix.node-version }}-artifacts

diff --git a/.gitignore b/.gitignore
@@ -5,7 +5,9 @@
 /_playwright-results
 /lib
 /node_modules
-/themes
+/.husky/_
 
 # exceptions
 !.gitkeep
+.vercel
+
diff --git a/.gitpod.yml b/.gitpod.yml
@@ -7,4 +7,4 @@ ports:
     onOpen: ignore
 vscode:
   extensions:
-    - [email protected]:xX39oruAJ5UQzTNVRdbBaQ==
+    - [email protected]:xX39oruAJ5UQzTNVRdbBaQ==
diff --git a/.husky/pre-commit b/.husky/pre-commit
@@ -0,0 +1,5 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+npm run prettier
+npx lint-staged
diff --git a/.npmignore b/.npmignore
@@ -1,5 +1,4 @@
 .eslintignore
-.eslintrc
+.eslintrc.cjs
 .github
 .gitignore
-.travis.yml
diff --git a/.prettierignore b/.prettierignore
@@ -0,0 +1,6 @@
+CHANGELOG.md
+HISTORY.md
+lib/
+themes/
+_playwright-*/
+emoji-data.*
diff --git a/.prettierrc.js b/.prettierrc.js
diff --git a/.prettierrc.json b/.prettierrc.json
@@ -0,0 +1,4 @@
+{
+  "arrowParens": "avoid",
+  "singleQuote": true
+}