feat: docusaurus support

.github/ISSUE_TEMPLATE/bug_report.md

@@ -12,6 +12,7 @@ A clear and concise description of what the bug is.
 
 **To Reproduce**
 Steps to reproduce the behavior:
+
 1. Go to '...'
 2. Click on '....'
 3. Scroll down to '....'
@@ -24,9 +25,10 @@ A clear and concise description of what you expected to happen.
 If applicable, add screenshots to help explain your problem.
 
 **Desktop (please complete the following information):**
- - OS: [e.g. MacOS]
+
+- OS: [e.g. MacOS]
 - Obsidian version [e.g 1.14.1]
- - O2 Plugin version [e.g. 1.2.x]
+- O2 Plugin version [e.g. 1.2.x]
 
 **Additional context**
 Add any other context about the problem here.

.github/pull_request_template.md

@@ -1,4 +1,6 @@
-## PR Checklist
+# Pull Request
+
+## Checklist
 
 Please check if your PR fulfills the following requirements:
 

.github/workflows/auto-assign-action.yml

@@ -3,9 +3,10 @@ on:
   pull_request_target:
     types: [opened, ready_for_review]
 
+permissions: { }
+
 jobs:
   add-reviews:
     runs-on: ubuntu-latest
     steps:
       - uses: kentaro-m/[email protected]
-

.github/workflows/auto-release.yml

@@ -9,6 +9,8 @@ on:
     branches:
       - main
 
+permissions: { }
+
 env:
   PLUGIN_NAME: o2
 

.github/workflows/ci.yml

@@ -6,6 +6,8 @@ on:
   pull_request:
     branches: [ "main" ]
 
+permissions: { }
+
 jobs:
   run:
     runs-on: ubuntu-latest
@@ -20,5 +22,13 @@ jobs:
         run: npm install
       - name: Run tests and collect coverage
         run: npm run test
-      - name: Upload coverage to Codecov
-        uses: codecov/codecov-action@v3
+
+      - uses: actions/checkout@main
+      - uses: codecov/codecov-action@v4
+        with:
+#          fail_ci_if_error: true # optional (default = false)
+#          files: ./coverage1.xml,./coverage2.xml # optional
+#          flags: unittests # optional
+#          name: codecov-umbrella # optional
+          token: ${{ secrets.CODECOV_TOKEN }} # required
+          verbose: true # optional (default = false)

.github/workflows/linter.yml

@@ -3,29 +3,35 @@ name: Lint Code Base
 
 on:
   push:
-    branches-ignore: [main]
+    branches-ignore: [ main ]
   pull_request:
-    branches: [main]
+    branches: [ main ]
+
+permissions: { }
 
 jobs:
   build:
     name: Lint Code Base
     runs-on: ubuntu-latest
 
+    permissions:
+      contents: read
+      packages: read
+      # To report GitHub Actions status checks
+      statuses: write
+
     steps:
       - name: Checkout Code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           # Full git history is needed to get a proper
           # list of changed files within `super-linter`
           fetch-depth: 0
 
-      - name: Lint Code Base
-        uses: github/super-linter@v4
+      - name: Super-linter
+        uses: super-linter/super-linter@v6.6.0  # x-release-please-version
         env:
-          VALIDATE_ALL_CODEBASE: false
-          DEFAULT_BRANCH: main
+          # To report GitHub Actions status checks
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          # temporarily disable this until we can fix the errors
-          # https://github.com/github/super-linter/discussions/2745
-          VALIDATE_TYPESCRIPT_STANDARD: false
+          VALIDATE_JAVASCRIPT_STANDARD: "false"
+          VALIDATE_TYPESCRIPT_STANDARD: "false"

.tool-versions

@@ -1 +1 @@
-nodejs 20.5.0
+nodejs lts

CODE_OF_CONDUCT.md

@@ -52,7 +52,7 @@ decisions when appropriate.
 
 This Code of Conduct applies within all community spaces, and also applies when
 an individual is officially representing the community in public spaces.
-Examples of representing our community include using an official e-mail address,
+Examples of representing our community include using an official email address,
 posting via an official social media account, or acting as an appointed
 representative at an online or offline event.
 
@@ -106,7 +106,7 @@ Violating these terms may lead to a permanent ban.
 ### 4. Permanent Ban
 
 **Community Impact**: Demonstrating a pattern of violation of community
-standards, including sustained inappropriate behavior,  harassment of an
+standards, including sustained inappropriate behavior, harassment of an
 individual, or aggression toward or disparagement of classes of individuals.
 
 **Consequence**: A permanent ban from any sort of public interaction within
@@ -115,14 +115,15 @@ the community.
 ## Attribution
 
 This Code of Conduct is adapted from the [Contributor Covenant][homepage],
-version 2.0, available at
-https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+version 2.0, available
+at [contributor-covenant.org](https://www.contributor-covenant.org/version/2/0/code_of_conduct.html).
 
 Community Impact Guidelines were inspired by [Mozilla's code of conduct
 enforcement ladder](https://github.com/mozilla/diversity).
 
 [homepage]: https://www.contributor-covenant.org
 
-For answers to common questions about this code of conduct, see the FAQ at
-https://www.contributor-covenant.org/faq. Translations are available at
-https://www.contributor-covenant.org/translations.
+For answers to common questions about this code of conduct, see the FAQ
+at [contributor-covenant.org/faq](https://www.contributor-covenant.org/faq).
+Translations are available
+at [contributor-covenant.org/translations](https://www.contributor-covenant.org/translations).

README.md

@@ -53,18 +53,19 @@ your jekyll project (ex: /Users/user1/Documents/GitHub/user1.github.io)
 
 - jekyllPath is the path of your jekyll project (ex: /Users/user1/Documents/GitHub/user1.github.io).
 - Attachments will be copied by the date under the `assets/img/<yyyy-MM-dd>` folder.
-- Auto create folders: If enabled, the plugin will automatically create the necessary folders if they do not exist. You can toggle this setting in the plugin settings tab.
+- Auto create folders: If enabled, the plugin will automatically create the necessary folders if they do not exist. You
+  can toggle this setting in the plugin settings tab.
 
 #### Syntax
 
 | Feature              | Obsidian (AS-IS)                | Jekyll Chirpy (TO-BE)                                                                  | Description                                        |
 |----------------------|---------------------------------|----------------------------------------------------------------------------------------|----------------------------------------------------|
-| Wiki link            | [[What is Obsidian?]]           | What is Obsidian?                                                                      |
+| Wiki link            | [[What is Obsidian?]]           | What is Obsidian?                                                                      |                                                    |
 | Image                | ![[NewJeans.png]]               | `![image](/assets/img/<yyyy-MM-dd>-<title>/NewJeans.png)`                              | `yyyy-MM-dd` is replaced by the date of converting |
-| Resize image (width) | ![[NewJeans.png&#124;100]]      | `![image](/assets/img/<yyyy-MM-dd>-<title>/NewJeans.png){: width="100" }`              |
-| Resize image (w & h) | ![[NewJeans.png&#124;100x200]]  | `![image](/assets/img/<yyyy-MM-dd>-<title>/NewJeans.png){: width="100" height="200" }` |
-| Embeds               | ![[Obsidian#This is Obsidian!]] | Obsidian                                                                               |
-| Comments             | %% This is a comment %%         | `<!-- This is a comment -->`                                                           |
+| Resize image (width) | ![[NewJeans.png&#124;100]]      | `![image](/assets/img/<yyyy-MM-dd>-<title>/NewJeans.png){: width="100" }`              |                                                    |
+| Resize image (w & h) | ![[NewJeans.png&#124;100x200]]  | `![image](/assets/img/<yyyy-MM-dd>-<title>/NewJeans.png){: width="100" height="200" }` |                                                    |
+| Embeds               | ![[Obsidian#This is Obsidian!]] | Obsidian                                                                               |                                                    |
+| Comments             | %% This is a comment %%         | `<!-- This is a comment -->`                                                           |                                                    |
 | Footnotes            | [^1]                            | `[^fn-nth-1]`                                                                          | Currently, only supports the simple syntax         |
 | Curly braces         | {{ content }}                   | `{% raw %}{{ content }}{% endraw %}`                                                   | Optional                                           |
 
@@ -78,7 +79,8 @@ issue.
 
 ## Contributing
 
-Pull requests are always welcome! For major changes, please open an issue(or discussion) first to discuss what you would like to
+Pull requests are always welcome! For major changes, please open an issue (or discussion) first to discuss what you would like to change.
+like to
 change.
 
 For the detailed information about building and developing O2,

jest.config.js

@@ -1,11 +1,11 @@
 module.exports = {
-    preset: 'ts-jest',
-    testEnvironment: 'node',
-    transform: {
-        '^.+\\.ts?$': 'ts-jest',
-    },
-    transformIgnorePatterns: ['<rootDir>/node_modules'],
-    moduleDirectories: ['node_modules', 'src'],
-    collectCoverage: true,
-    coverageReporters: ['text', 'cobertura'],
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+  transform: {
+    '^.+\\.ts?$': 'ts-jest'
+  },
+  transformIgnorePatterns: ['<rootDir>/node_modules'],
+  moduleDirectories: ['node_modules', 'src'],
+  collectCoverage: true,
+  coverageReporters: ['text', 'cobertura']
 };