Add Goldendict Tools (#1692)

* Create topic_gd-tools.md * Update mkdocs.yml * Update mkdocs.yml * Update topic_gd-tools.md * Update website/docs/topic_gd-tools.md --------- Co-authored-by: shenleban tongying <[email protected]> Co-authored-by: xiaoyifang <[email protected]>
xiaoyifang · Jul 16, 2024 · fac8dfb · fac8dfb
1 parent 9c6e228
commit fac8dfb
Show file tree

Hide file tree

Showing 2 changed files with 32 additions and 2 deletions.
diff --git a/website/docs/topic_gd-tools.md b/website/docs/topic_gd-tools.md
@@ -0,0 +1,28 @@
+# GoldenDict tools
+
+A set of helpful programs to enhance goldendict for immersion learning.
+
+
+# prerequisite
+1. install [gd-tools](https://codeberg.org/hashirama/gd-tools) and configure it according to its README
+
+# features:
+- japanese sentence spliting, making each part of the sentence clickable
+![Alt](https://codeberg.org/hashirama/gd-tools/raw/branch/main/misc/marisa.gif)
+
+## How to setup:
+Open GoldenDict, press "Edit" > "Dictionaries" > "Programs" and add the installed executables. Set type to html. Command Line: gd-tools <name of the program> --word %GDWORD% --sentence %GDSEARCH%. Optionally add arguments, such as: gd-tools marisa --word %GDWORD% --sentence %GDSEARCH% . These programs are treated as dictionaries and you can add them under "Dictionaries" or "Groups".
+<br><br>
+please notice that gd-tools does works in windows, and we have an [installer](https://www.mediafire.com/file/h1v7owj7np9j7wg/gd-tools_windows.zip/file) for it, you can install and then come back to the previous instruction.
+And if you're at Gnu Guix, install it from our [channel](https://codeberg.org/hashirama/ajattix) <br><br>
+other features:
+- kanji stroke order: for those who want to know how to write a character
+- image searching
+and much more, please see our list [here](https://codeberg.org/hashirama/gd-tools/src/branch/main/README.md#table-of-contents)
+
+# Misc
+we have a mandarin version of gd-marisa, which relies on mecab (unix only) : <br><br>
+![image](https://codeberg.org/hashirama/gd-tools/raw/branch/main/misc/mandarin.png)
+
+# Notes
+This article was written by 柱間(developer of gd-tools).
diff --git a/website/mkdocs.yml b/website/mkdocs.yml
@@ -37,17 +37,19 @@ nav:
       - Favorites: ui_favorites.md
       - Shortcuts: ui_shortcuts.md
   - Advanced Usages:
-      - Anki Integration: topic_anki.md
       - Program dictionary: howto/how to add a program as dictionary.md
       - Command Lines: topic_commandline.md
       - Custom Stylesheet & JavaScript: topic_userstyle.md
       - Portable Mode: topic_portablemode.md
       - Custom transliteration: topic_transliteration.md
       - Customize Dictionary: custom_dictionary.md
-      - OCR Integration: howto/ocr.md
       - Wayland: topic_wayland.md
       - Debug dictionary JS: howto/how to debug dictionary js.md
       - Flatpak/FlatHub: topic_flatpak.md
+  - Related tools:
+      - Anki Integration: topic_anki.md
+      - OCR Integration: howto/ocr.md
+      - gd-tools: topic_gd-tools.md
   - Report Bugs & Feedbacks: feedbacks.md
   - Development Info:
     - Start develop: developer.md