Merge pull request #57 from jamesmaa/update-oct-2

More cleanup

docs/advanced/index.md → docs/advanced.md

@@ -30,6 +30,8 @@ The following shortcuts are available on search results:
 | <kbd>Alt</kbd> + <kbd>P</kbd>    | Play audio for current term.            |
 | <kbd>Alt</kbd> + <kbd>K</kbd>    | Add current kanji to Anki.              |
 
+Shortcuts are configurable in the "Shortcuts" section of the settings page.
+
 ---
 
 ## Advanced Scanning Options
@@ -38,7 +40,7 @@ The following shortcuts are available on search results:
 
 To enable Yomitan scanning on local files, go to `Settings` > `Security` > `Configure Yomitan Permissions`, and navigate to the `Allow access to file URLs` option. From there, follow the link to the browser's settings pages, and check `Allow access to file URLs` on Chrome/Edge, or `Access your data for all websites` for Firefox.
 
-Yomitan may not work on PDF files. When that happens, drag and drop your PDF file into [our PDF Viewer](../yomitan-pdf-viewer/index.html).
+Yomitan may not work on PDF files. When that happens, drag and drop your PDF file into [our PDF Viewer](yomitan-pdf-viewer/index.html).
 
 ### Scanning in private windows
 
@@ -50,7 +52,7 @@ To enable Yomitan scanning in private/incognito web browser windows, go to `Sett
 
 ### Default audio sources
 
-After looking up a term, you can click on the <img class="icon" src="../assets/icon/play-audio.svg" alt="" width="16" height="16"> _speaker_ button to hear the term's pronunciation. When searching for audio, multiple audio sources are checked until the first source with audio for the term is found. If no audio is found, you will hear a short click instead. Right-clicking the <img class="icon" src="../assets/icon/play-audio.svg" alt="" width="16" height="16"> button allows choosing the source manually.
+After looking up a term, you can click on the ![](assets/icon/play-audio.svg){ width="16" } _speaker_ button to hear the term's pronunciation. When searching for audio, multiple audio sources are checked until the first source with audio for the term is found. If no audio is found, you will hear a short click instead. Right-clicking the ![](assets/icon/play-audio.svg){ width="16" } button allows choosing the source manually.
 
 #### Japanese
 
@@ -65,6 +67,7 @@ The default audio sources for other languages are from Wikimedia Commons:
 
 - Lingua Libre
 - Wiktionary
+- LanguagePod101
 
 While Commons has audio for many languages, some of them have limited coverage, and you may want to add additional sources, as described below.
 
@@ -84,7 +87,7 @@ To enable this, just add a new playback source with the `Text-to-speech` type an
 
 You can add a custom URL from which audio will be fetched. One use case for this is fetching audio from Forvo:
 
-##### Yomichan Forvo Server
+#### Yomichan Forvo Server
 
 [Forvo](https://forvo.com/) is currently the largest online pronunciation database, with native pronunciation audio for various languages. One way to get Forvo audio in Yomitan is via the [Yomichan Forvo Server](https://ankiweb.net/shared/info/580654285) Anki add-on. It fetches from Forvo, at the cost of a slight delay. After installing it in Anki, add a `Custom URL (JSON)` audio source with the URL `http://localhost:8770?term={term}&reading={reading}&language=en` (replacing `en` with the desired language's ISO code).
 

docs/anki/index.md → docs/anki.md

@@ -116,14 +116,14 @@ be able to create a flashcard for <ruby>箸<rt>はし</rt></ruby> because they s
 Once Yomitan is configured, it becomes trivial to create new flashcards with a single click. You will see the following
 icons next to term definitions:
 
-- Clicking ![](../assets/btn/btn-add-expression.png) adds the current expression (e.g. 食べる).
-- Clicking ![](../assets/btn/btn-add-reading.png) adds the current expression's reading (e.g. たべる).
+- Clicking ![](assets/btn/btn-add-expression.png) adds the current expression (e.g. 食べる).
+- Clicking ![](assets/btn/btn-add-reading.png) adds the current expression's reading (e.g. たべる).
 
 If _Check for card duplicates_ is on, and a card for the current definition already exists in the deck, you will see the book icon.
 If _When a duplicate is detected_ is set to `Prevent adding`, the icons will appear grayed out. If set to `Allow adding`, the icons will change to:
 
-- ![](../assets/btn/btn-add-duplicate-expression.png): to add the expression
-- ![](../assets/btn/btn-add-duplicate-reading.png): to add the reading
+- ![](assets/btn/btn-add-duplicate-expression.png): to add the expression
+- ![](assets/btn/btn-add-duplicate-reading.png): to add the reading
 
 Below are some troubleshooting tips you can try if you are unable to create new flashcards:
 

docs/dictionaries/index.md → docs/dictionaries.md

@@ -24,24 +24,32 @@ Be aware that non-English dictionaries generally contain fewer entries than thei
 - [BCCWJ Frequency Dictionary](https://github.com/Kuuuube/yomitan-dictionaries?tab=readme-ov-file#bccwj-suw-luw-combined) - A frequency dictionary based on the Balanced Corpus of Contemporary Written Japanese.
 - [JPDB Frequency Dictionary](https://github.com/Kuuuube/yomitan-dictionaries?tab=readme-ov-file#jpdb-v21-frequency) - A frequency dictionary based on the corpus from the online Japanese dictionary and SRS system at [jpdb.io](https://jpdb.io).
 
+??? note "EPWING Dictionaries"
+
+    Yomitan supports dictionaries in the esoteric but popular [EPWING](https://ja.wikipedia.org/wiki/EPWING) format. They were often utilized in portable electronic dictionaries. These dictionaries are often sought after by language learners for their correctness and excellent coverage of the Japanese language.
+
+    Unfortunately, as most of the dictionaries released in this format are proprietary, you will need to procure these dictionaries yourself and import them using [Yomitan Import](https://github.com/yomidevs/yomitan-import). Check the project page for additional details.
+
+
 #### Other Languages
 
-- **Multilingual**
-  - [KTY](https://github.com/yomidevs/kaikki-to-yomitan) - Wiktionaries in various languages converted to Yomitan format.
+!!! note
+
+    If you can't find suitable Yomitan dictionaries, feel free to Google for dictionaries in your specific language or ask your fellow community members
+
+**Multilingual**
+
+  - [KTY](https://github.com/yomidevs/kaikki-to-yomitan/blob/master/downloads.md) - Wiktionaries in various languages converted to Yomitan format.
   - [Wikipedia for Yomitan](https://github.com/MarvNC/wikipedia-yomitan) - All of Wikipedia in Yomitan for various languages.
-- **Korean**
+
+**Korean**
+
   - [KRDICT/STDICT](https://github.com/Lyroxide/yomitan-ko-dic/releases) - Korean dictionaries for Yomitan.
-- **Cantonese**
+**Cantonese**
   - [words.hk for Yomitan](https://github.com/MarvNC/wordshk-yomitan) - A free Cantonese-English and Cantonese-Cantonese dictionary for Yomitan.
-- **Mandarin**
+**Mandarin**
   - [CC-CEDICT for Yomitan](https://github.com/MarvNC/cc-cedict-yomitan) - A free Chinese-English dictionary for Yomitan.
 
-#### EPWING Dictionaries
-
-Yomitan supports dictionaries in the esoteric but popular [EPWING](https://ja.wikipedia.org/wiki/EPWING) format. They were often utilized in portable electronic dictionaries. These dictionaries are often sought after by language learners for their correctness and excellent coverage of the Japanese language.
-
-Unfortunately, as most of the dictionaries released in this format are proprietary, you will need to procure these dictionaries yourself and import them using [Yomitan Import](https://github.com/yomidevs/yomitan-import). Check the project page for additional details.
-
 ### Bulk Importing Dictionaries
 
 Yomitan also supports exporting and importing your entire collection of dictionaries.

docs/getting-started/index.md → docs/getting-started.md

@@ -6,7 +6,7 @@ hide:
 
 This introduction will help you quickly familiarize yourself with the basics and set you up for a smooth language learning experience.
 
-!!! note "Migrating from Yomichan? Learn how to migrate to Yomitan [here](../yomichan-migration.md)"
+!!! note "Migrating from Yomichan? Learn how to migrate to Yomitan [here](yomichan-migration.md)"
 ---
 
 ## Installation
@@ -49,23 +49,23 @@ Now that you have installed Yomitan, let's explore how you can utilize her featu
 
 ### Quick-actions
 
-Click the <img class="icon" src="../assets/icon/yomitan-icon.svg" width="16" height="16" alt="yomitan icon"> _Yomitan_ button in the browser bar to open the quick-actions popup.
+Click the ![yomitan icon](assets/icon/yomitan-icon.svg){ width="16" } _Yomitan_ button in the browser bar to open the quick-actions popup.
 
-<img class="ss" src="../assets/ss/browser-action-popup.webp" alt="yomitan main popup">
+![](assets/ss/browser-action-popup.webp){ width="120" }
 
-- The <img class="icon" src="../assets/icon/cog.svg" width="16" height="16" alt="cog"> _cog_ button will open the Settings page.
-- The <img class="icon" src="../assets/icon/magnifying-glass.svg" width="16" height="16" alt="magnifying glass"> _magnifying glass_ button willopen the Search page.
-- The <img class="icon" src="../assets/icon/question-mark-circle.svg" width="16" height="16" alt="question mark symbol"> _question mark_ buttonwill open the Information page.
-- The <img class="icon" src="../assets/icon/profile.svg" width="16" height="16" alt="profile icon"> _profile_ button will appear when multipleprofiles exist, allowing the current profile to be quickly changed.
+- The ![profile icon](assets/icon/profile.svg){ width="16" } _profile_ button will appear when multipleprofiles exist, allowing the current profile to be quickly changed.
+- The ![cog](assets/icon/cog.svg){ width="16" } _cog_ button will open the Settings page.
+- The ![magnifying glass](assets/icon/magnifying-glass.svg){ width="16" } _magnifying glass_ button willopen the Search page.
+- The ![question mark symbol](assets/icon/question-mark-circle.svg){ width="16" } _question mark_ buttonwill open the Information page.
 
 ### Installing Dictionaries
 
-To import the dictionaries you wish to use for term searches, head over to [Dictionary](../dictionaries/index.md) to get set up!
+To import the dictionaries you wish to use for term searches, head over to [Dictionaries](dictionaries.md) to get set up!
 
 If you do not have any dictionaries installed or enabled. Yomitan will warn you that it is not ready for use by displaying an orange exclamation mark over its icon. This exclamation mark will disappear once you have installed and enabled at least one dictionary.
 
-<figure>
-    <img class="ss" src="../assets/ss/settings-dictionaries-popup.webp" width="550" alt="custom dictionaries list">
+<figure markdown="span">
+    ![custom dictionaries list](assets/ss/settings-dictionaries-popup.webp){ width="550" }
 </figure>
 
 ### Scanning Text
@@ -74,19 +74,19 @@ Webpage text can be scanned by moving the cursor while holding a modifier key, w
 
 If definitions are found for the text at the cursor position, a popup window containing term definitions will open. This window can be dismissed by clicking anywhere outside of it.
 
-<figure>
-    <a href="https://www.wikiwand.com/en/articles/English_language#Classification">
-    <img class="ss" src="../assets/ss/search-popup-terms.webp" width="850" alt="popup with search terms">
+<figure markdown="span">
+    <a href="https://en.wikipedia.org/wiki/English_language#Classification">
+    ![popup with search terms](assets/ss/search-popup-terms.webp){ width="850" }
     </a>
     <figcaption><small>Try it yourself!</small></figcaption>
 </figure>
 
 ### Audio
 
-Click on the <img class="icon" src="../assets/icon/play-audio.svg" width="16" height="16" alt="loudspeaker icon"> _speaker_ button to hear the term pronounced by a native speaker.
+Click on the ![loudspeaker icon](assets/icon/play-audio.svg){ width="16" } _speaker_ button to hear the term pronounced by a native speaker.
 
-If an audio sample is not available, you will hear a short click instead. For more options, see [Audio Configuration](../advanced/index.md#audio).
+If an audio sample is not available, you will hear a short click instead. For more options, see [Audio Configuration](advanced.md#audio).
 
 ### Anki
 
-To further enhance your Yomitan experience, it's worth [integrating with Anki](../anki/index.md), a spaced-repetition flashcard program to help solidify the words you encounter.
+To further enhance your Yomitan experience, it's worth [integrating with Anki](anki.md), a spaced-repetition flashcard program to help solidify the words you encounter.

docs/index.md

@@ -19,7 +19,7 @@ hide:
 
 </div>
 
-[Get started](getting-started/index.md){ .md-button .md-button--stretch }
+[Get started](getting-started.md){ .md-button .md-button--stretch }
 
 ---
 
@@ -59,7 +59,7 @@ Yomitan turns your web browser into a tool for building language literacy by hel
 
     ---
 
-    [:octicons-arrow-right-24: More information](./advanced/index.md#audio)
+    [:octicons-arrow-right-24: More information](./advanced.md#audio)
 
 -   :earth_asia:{ .lg .middle } &nbsp;
     __Multilanguage Support__
@@ -83,17 +83,17 @@ Yomitan turns your web browser into a tool for building language literacy by hel
 
     ---
 
-    [:octicons-arrow-right-24: More information](./anki/index.md)
+    [:octicons-arrow-right-24: More information](./anki.md)
 
 -   :heart:{ .lg .middle } &nbsp;
     __And Much More__
 
     ---
 
-    - :book: [Support for multiple dictionaries.](./dictionaries/index.md)
+    - :book: [Support for multiple dictionaries.](./dictionaries.md)
     - :material-cloud-off: Works fully offline. No internet connection needed.
-    - :material-wrench: [Extremely customizable. Hotkeys, custom audio, custom appearance.](advanced/index.md)
+    - :material-wrench: [Extremely customizable. Hotkeys, custom audio, custom appearance.](advanced.md)
     - :material-currency-usd-off: Completely free! We don't track your data and we're completely [open-sourced](https://github.com/yomidevs/yomitan).
 </div>
 
-[Get started](getting-started/index.md){ .md-button .md-button--stretch-max-sm }
+[Get started](getting-started.md){ .md-button .md-button--stretch-max-sm }

docs/supporting-tools.md → docs/tools-resources.md

@@ -4,24 +4,36 @@ hide:
   - footer
 ---
 
-A compiled list of software that improves your Yomitan experience.
+A compiled list of tools and resources that improve your Yomitan experience.
 
 ### Media players
 
+Media players load and play media and enable Yomitan lookups.
+
 #### [Asbplayer](https://github.com/killergerbah/asbplayer?tab=readme-ov-file#getting-started)
 
-A browser-based media player and Chrome extension that can add text-selectable and Yomitan-scannable subtitles onto video sources (e.g. Netflix and Youtube).
+A browser-based media player and Chrome extension that can add text-selectable and Yomitan-scannable subtitles onto video sources (e.g. Netflix, Youtube, and video files).
+
+#### [AnimeCards Guide for MPV](https://animecards.site/minefromanime/)
+
+A guide for adding text-selectable subtitles and mining from the [MPV video player](https://mpv.io/)
 
 ### Readers
 
+Readers allow reading books and text on your browser which makes the text you read Yomitan-compatible.
+
 #### [Ttsu Reader](https://reader.ttsu.app/)
 
-An online e-book reader that works flawlessly with Yomitan.
+A minimal e-book reader that loads HTMLZ, Plain Text and EPUB files. Supports offline mode that makes this ideal for mobile and e-readers. This is the recommendation for Japanese learners.
+
+### [Koodo Reader](https://web.koodoreader.com/)
+
+An ebook manager and reader with wider support of file formats. No support on mobile.
 
 #### [PDF Reader](yomitan-pdf-viewer/index.html)
 Reading PDF's in your browser that is Yomitan-scannable
 
-### Community Tooling
+### Tooling
 
 !!! warning "These are not made nor maintained by Yomitan developers, and it may break Yomitan's functionalities."
 

mkdocs.yml

@@ -6,13 +6,13 @@ repo_url: https://github.com/yomidevs/yomitan
 repo_name: Yomitan
 nav:
   - Home: 'index.md'
-  - Getting started: 'getting-started/index.md'
-  - Dictionaries: 'dictionaries/index.md'
-  - Anki: 'anki/index.md'
-  - Advanced Features: 'advanced/index.md'
-  - Supporting Tools: 'supporting-tools.md'
-  - Tech Support: 'support/index.md'
-  - Contributing: 'contributing/index.md'
+  - Getting started: 'getting-started.md'
+  - Dictionaries: 'dictionaries.md'
+  - Anki: 'anki.md'
+  - Advanced Features: 'advanced.md'
+  - Tools & Resources: 'tools-resources.md'
+  - Tech Support: 'support.md'
+  - Contributing: 'contributing.md'
 theme:
   name: material
   favicon: assets/icon/yomitan-icon64.png