docs: update README.md

songkg7 · Jul 22, 2024 · 334f14b · 334f14b
1 parent 94ab4c6
commit 334f14b
Showing 1 changed file with 4 additions and 37 deletions.
diff --git a/README.md b/README.md
@@ -24,7 +24,7 @@ You should have a folder structure like this. (of course, you can change the fol
 ```text
 Your vault
 ├── ready (where the notes you want to convert are placed)
-├── backup (where the original notes before converting are placed)
+├── archive (where the original notes before converting are placed)
 └── attachments (where the attachments are placed)
 ```
 
@@ -40,43 +40,10 @@ if exception occurs, you can see the original note in the `backup` folder.
 
 ## Supported platforms
 
-### Jekyll Chirpy
+- Jekyll Chirpy
+- Docusaurus
 
-#### Settings
-
-```text
-your jekyll project (ex: /Users/user1/Documents/GitHub/user1.github.io)
-├── _posts (where the converted notes are placed)
-└── assets
-    └── img
-        └── yyyy-MM-dd-title (where the attachments are placed. yyyy-MM-dd is replaced by the date of converting)
-```
-
-- 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.
-
-#### Syntax
-
-| Feature              | Obsidian (AS-IS)                | Jekyll Chirpy (TO-BE)                                                                  | Description                                        |
-|----------------------|---------------------------------|----------------------------------------------------------------------------------------|----------------------------------------------------|
-| 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 -->`                                                           |                                                    |
-| Footnotes            | [^1]                            | `[^fn-nth-1]`                                                                          | Currently, only supports the simple syntax         |
-| Curly braces         | {{ content }}                   | `{% raw %}{{ content }}{% endraw %}`                                                   | Optional                                           |
-
-Grammars not in the table are ignored. If there is a syntax you would like to convert, please let me know in an
-issue.
-
-### Docusaurus 3.x
-
-> [!NOTE]
-> since 2.0.0 (WIP)
+Please visit the [documentation](https://haril.dev/docs/category/o2) for more information.
 
 ## Plugins that work well together