docs: update document (#28)

* docs: move document directory

* chore: add spell vocabulary

* chore: update directory path

* Update README.md

* chore: remove unnecessary image

* docs: add new image

* Update README.md

* Update README.md

* docs: update README.md

* chore: add spell vocabulary

* docs: update README.md

* docs: update README.md

* docs: disable MD033 error

* docs: add gif

* docs: add new section

Author: MaruTama

.github/workflows/code-quality.yml

@@ -125,7 +125,7 @@ jobs:
 
       - name: Run spell check
         run: |
-          cspell "src/refactored/**/*.py" "tests/**/*.py" "*.md" "doc/*.md" --config cspell.json
+          cspell "src/refactored/**/*.py" "tests/**/*.py" "*.md" "docs/*.md" --config cspell.json
 
   markdown-lint:
     name: Markdown Lint
@@ -147,4 +147,4 @@ jobs:
 
       - name: Lint Markdown files
         run: |
-          markdownlint "*.md" "doc/*.md" --config .markdownlint.json --ignore node_modules
+          markdownlint "*.md" "docs/*.md" --config .markdownlint.json --ignore node_modules

.markdownlint.json

@@ -12,6 +12,7 @@
   "MD033": {
     "allowed_elements": [
       "img",
+      "video",
       "div",
       "details",
       "summary"

.vscode/settings.json

@@ -188,20 +188,6 @@
     "source.organizeImports": "explicit",
     "source.fixAll.markdownlint": "explicit"
   },
-  // Markdownlint specific settings
-  "markdownlint.config": {
-    "MD033": {
-      "allowed_elements": [
-        "img"
-      ]
-    },
-    "MD045": false,
-    "MD025": false,
-    "MD029": {
-      "style": "ordered"
-    },
-    "MD059": false
-  },
   // Python-specific settings
   "[python]": {
     "editor.formatOnSave": true,

README.md

@@ -40,7 +40,7 @@ This fonts can display basic Japanese, Simplified Chinese and Traditional Chines
 - [macOS](https://support.apple.com/en-us/HT201749)
 - [Windows](https://support.microsoft.com/en-us/help/314960/how-to-install-or-remove-a-font-in-windows)
 - [Linux/Unix-based systems](https://github.com/adobe-fonts/source-code-pro/issues/17#issuecomment-8967116)
-- [Android](./doc/HOW_TO_APPLY_FONT_ON_ANDROOID.md)
+- [Android](./docs/HOW_TO_APPLY_FONT_ON_ANDROOID.md)
 
 ----
 
@@ -53,11 +53,7 @@ Subtitles are shown Chinese characters and pinyin.
 [Language Learning with Netflix](https://chrome.google.com/webstore/detail/language-learning-with-ne/hoombieeljmmljlkjmnheibnpciblicm?hl=en)
 ![An-example-of-how-to-use](./imgs/An-example-of-how-to-use.png)
 
-<details><summary>Enable homograph features in Microsoft Word</summary><div>
-
-Please turn on any of the features under Font - Advanced - OpenType Features (suggest to choose Ligatures: Standard Only or tick Use Contextual Alternates, but other options are OK too) to display the correct pinyin in Microsoft Word. By default, Word will not use any OpenType features (including automatically changing the pinyin) if none of the options are used. Microsoft Excel turns on the feature by default, and is not affected.
-![word-setting](./imgs/word_setting.png)
-</div></details>
+- [Microsoft Word Setup for Homograph Features](./docs/MICROSOFT_WORD_SETUP.md)
 
 ----
 
@@ -66,21 +62,28 @@ Please turn on any of the features under Font - Advanced - OpenType Features (su
 多音字をサポートするためにコンテキスト置換(feature tag of "rclt" at GSUB)を実装しました。
 また、Unicode IVS（表意文字バリアントセレクター）を使用して、異なる拼音に切り替えることもできます。/
 Implemented contextual replacing to support homograph (多音字).
-You can also use Unicode IVS (ideographic variant selector) to switch other different pinyin.
-<!-- ![](./imgs/2020-10-25-19.17.04.gif) -->
+You can also use Unicode IVS (ideographic variant selector) to switch other different pinyin.  
 ![using_contextual_replacing](./imgs/using_contextual_replacing.gif)
 ![using_ideographic_variant_selector](./imgs/using_ideographic_variant_selector.gif)
 
+## 各OSでの動作 / Works on each OS
+
+|Platform|Automatic pinyin switching (using Contextual Replacement)|Manual pinyin switching (using IVS)|Notes|
+|:-:|:-:|:-:|:-:|
+|Windows|<video src="https://github.com/user-attachments/assets/7478707f-091b-43e5-ab6f-117281ba67ee">|<video src="https://github.com/user-attachments/assets/19b9a839-2504-4f44-96ea-ec28b3836865">|Use [IME Pad for IVS](./docs/IVS_SETUP_GUIDE.md)|
+|Mac|<video src="https://github.com/user-attachments/assets/9d791b54-76f4-43ba-bd1b-dd5db270bf5b">|<video src="https://github.com/user-attachments/assets/62c5567e-5ba0-48b0-b196-fd3db5322dae">|Use [Character Viewer for IVS](./docs/IVS_SETUP_GUIDE.md)|
+|Android|![android-chrome-rclt](imgs/android-chrome-rclt.png)|-|・[zFont Setup Guide](./docs/HOW_TO_APPLY_FONT_ON_ANDROOID.md) </br>・[Magisk module](https://github.com/MaruTama/magisk-module-mengshen-font) (root required, IVS works in Chrome only)|
+
 ----
 
 ## 対応している多音字の一覧 / List of Supported Homographs
 
-- [supported homograph](./doc/DUOYINZI_DICTIONARY.md)
+- [supported homograph](./docs/DUOYINZI_DICTIONARY.md)
 
 ## 生成方法 / How to Make Fonts
 
-- [日本語](./doc/HOW_TO_MAKE_JP.md)
-- [English](./doc/HOW_TO_MAKE_EN.md)
+- [日本語](./docs/HOW_TO_MAKE_JP.md)
+- [English](./docs/HOW_TO_MAKE_EN.md)
 
 ## リファクタコード構成 / Refactored Code Architecture
 
@@ -158,4 +161,4 @@ Thank you to the following people and repositories.
 
 ## カンパ/打赏/Donate
 
-[点击进入打赏页面](./doc/DONATE.md)
+[点击进入打赏页面](./docs/DONATE.md)

cspell.json

@@ -348,7 +348,42 @@
     "premake",
     "OTFCCGSUB",
     "ccmp",
-    "uswinascent"
+    "uswinascent",
+    "wikipadia",
+    "hira",
+    "voicedcomb",
+    "afdko",
+    "Sawarabi",
+    "Mincho",
+    "googlefonts",
+    "fontmake",
+    "Robo",
+    "pteromys",
+    "svgs",
+    "fontforge",
+    "TESTFLIGHT",
+    "Inkscape",
+    "AFDKO",
+    "makeotf",
+    "GPOS",
+    "caculate",
+    "Tōngyòng",
+    "Guīfàn",
+    "Hànzìbiǎo",
+    "Unihan",
+    "CHISE",
+    "sawarabi",
+    "otfbuild",
+    "CNTXT",
+    "nopinyin",
+    "pypintin",
+    "ménr",
+    "diàor",
+    "gānr",
+    "jiànr",
+    "bǐng",
+    "BUILDKIT",
+    "numpad",
   ],
   "ignorePaths": [
     ".git/**",

doc/DONATE.md docs/DONATE.mddoc/DONATE.md renamed to docs/DONATE.md

@@ -10,60 +10,48 @@ I confirmed on Redmi Note 9S (MIUI 12).
 
 1. Install and launch zFont.
 
-   <!-- markdownlint-disable-next-line MD033 -->
    <img src="../imgs/install2android/picture_0.png" width="200" alt="zFont app home screen"/>
 
 2. Go to the LOCAL tab and press the button in the bottom right.
 
-   <!-- markdownlint-disable-next-line MD033 -->
    <img src="../imgs/install2android/picture_1.png" width="200" alt="zFont LOCAL tab with bottom right button"/>
 
 3. Choose Mengshen-HanSerif.ttf or Mengshen-Handwritten.ttf and check it.
    (Note: In the screenshot, Mengshen-Handwritten.ttf is renamed to mengshen.ttf)
 
-   <!-- markdownlint-disable-next-line MD033 -->
    <img src="../imgs/install2android/picture_2.png" width="200" alt="Font selection screen showing Mengshen font files"/>
 
 4. After verifying the font, press the SET button.
 
-   <!-- markdownlint-disable-next-line MD033 -->
    <img src="../imgs/install2android/picture_3.png" width="200" alt="Font verification screen with SET button"/>
 
 5. Click on Xiaomi(MIUI).
 
-   <!-- markdownlint-disable-next-line MD033 -->
    <img src="../imgs/install2android/picture_4.png" width="200" alt="Device selection screen showing Xiaomi(MIUI) option"/>
 
 6. Click on Method3.
    (Note: Don't choose Method4. For some reason, it seems the font doesn't change.)
 
-   <!-- markdownlint-disable-next-line MD033 -->
    <img src="../imgs/install2android/picture_5.png" width="200" alt="Method selection screen showing Method3 option"/>
 
 7. When the dialog appears, click OK.
 
-   <!-- markdownlint-disable-next-line MD033 -->
    <img src="../imgs/install2android/picture_6.png" width="200" alt="Confirmation dialog with OK button"/>
 
 8. You will be automatically redirected to the theme app.
 
 9. Select the theme with "(Apply me)" in its name.
 
-   <!-- markdownlint-disable-next-line MD033 -->
    <img src="../imgs/install2android/picture_7.png" width="200" alt="Theme app showing theme with (Apply me) in name"/>
 
 10. Press the apply button.
     Now you should see the pinyin font. If it doesn't change, try restarting.
 
-    <!-- markdownlint-disable-next-line MD033 -->
     <img src="../imgs/install2android/picture_8.png" width="200" alt="Theme apply screen showing pinyin font preview"/>
 
 Now, you can read comments with pinyin in apps like Weibo and TikTok!
-<!-- markdownlint-disable-next-line MD033 -->
 <img src="../imgs/install2android/picture_9.png" width="200" alt="Weibo app displaying Chinese text with pinyin annotations"/>
-<!-- markdownlint-disable-next-line MD033 -->
 <img src="../imgs/install2android/picture_10.png" width="200" alt="TikTok app displaying Chinese comments with pinyin"/>
-<!-- markdownlint-disable-next-line MD033 -->
 <img src="../imgs/install2android/picture_11.png" width="200" alt="Additional example of pinyin font in action"/>
 
 ## Magisk Module (requires root)