diff --git a/docs/assets/ss/search-popup-terms-english.webp b/docs/assets/ss/search-popup-terms-english.webp new file mode 100644 index 0000000..cf3f3c3 Binary files /dev/null and b/docs/assets/ss/search-popup-terms-english.webp differ diff --git a/docs/assets/ss/settings-dictionaries-popup-english.webp b/docs/assets/ss/settings-dictionaries-popup-english.webp new file mode 100644 index 0000000..cde0854 Binary files /dev/null and b/docs/assets/ss/settings-dictionaries-popup-english.webp differ diff --git a/docs/getting-started/index.md b/docs/getting-started/index.md index a07c501..d27e3c1 100644 --- a/docs/getting-started/index.md +++ b/docs/getting-started/index.md @@ -25,6 +25,7 @@ Let's dive in and get started! ### Firefox
+ [:fontawesome-brands-firefox-browser: Get Yomitan Firefox/Stable](https://addons.mozilla.org/en-US/firefox/addon/yomitan/){ .md-button .md-button--primary .md-button--stretch } [:fontawesome-brands-firefox-browser: Go To Github Releases](https://github.com/themoeway/yomitan/releases){ .md-button .md-button--primary .md-button--stretch } @@ -35,7 +36,8 @@ Let's dive in and get started! ### Edge
-[:fontawesome-brands-edge: Get Yomitan Edge/Stable](https://microsoftedge.microsoft.com/addons/detail/yomitan/idelnfbbmikgfiejhgmddlbkfgiifnnn){ .md-button .md-button--primary .md-button--stretch } + +[:fontawesome=brangs-edge: Get Yomitan Edge/Stable](https://microsoftedge.microsoft.com/addons/detail/yomitan/idelnfbbmikgfiejhgmddlbkfgiifnnn){.md-button .md-button--primary .md-button--stretch}
--- diff --git a/docs/getting-started/non_ja_example.md b/docs/getting-started/non_ja_example.md new file mode 100644 index 0000000..e10745a --- /dev/null +++ b/docs/getting-started/non_ja_example.md @@ -0,0 +1,81 @@ +--- +hide: + - navigation + - footer +--- + +This introduction will help you quickly familiarize yourself with the basics and set you up for a smooth language learning experience. + +Whether you're new to Yomitan or just need a refresher, here you'll find all the essential information you need to begin your journey. + +Let's dive in and get started! + +--- + +## Installation + +### Chrome +
+ +[:fontawesome-brands-chrome: Get Yomitan Chrome/Stable](https://chrome.google.com/webstore/detail/yomitan/likgccmbimhjbgkjambclfkhldnlhbnn){ .md-button .md-button--primary .md-button--stretch } + +[:fontawesome-brands-chrome: Get Yomitan Chrome/Beta](https://chrome.google.com/webstore/detail/yomitan-development-build/glnaenfapkkecknnmginabpmgkenenml){ .md-button .md-button--primary .md-button--stretch } +
+ +### Firefox +
+ +[:fontawesome-brands-firefox-browser: Get Yomitan Firefox/Stable](https://addons.mozilla.org/en-US/firefox/addon/yomitan/){.md-button .md-button--primary .md-button--stretch} + +[:fontawesome-brands-firefox-browser: Go To Github Releases](https://github.com/themoeway/yomitan/releases){ .md-button .md-button--primary .md-button--stretch } + +
+ +※ Unlike Chrome, Firefox does not allow extensions meant for testing to be hosted in the marketplace. You will have to download the desired version and side-load it yourself. You only need to do this once, and you will get updates automatically. + +### Edge +
+ +[:fontawesome=brangs-edge: Get Yomitan Edge/Stable](https://microsoftedge.microsoft.com/addons/detail/yomitan/idelnfbbmikgfiejhgmddlbkfgiifnnn){.md-button .md-button--primary .md-button--stretch} + +
+ +--- + +## Basic Usage + +Now that you have installed Yomitan, let's explore how you can utilize her features in your language learning journey. + +### Quick-actions + +Click the yomitan icon _Yomitan_ button in the browser bar to open the quick-actions popup. + +yomitan main popup + +- The cog _cog_ button will open the Settings page. +- The magnifying glass _magnifying glass_ button willopen the Search page. +- The question mark symbol _question mark_ buttonwill open the Information page. +- The profile icon _profile_ button will appear when multipleprofiles exist, allowing the current profile to be quickly changed. + +### Installing Dictionaries + +To import the dictionaries you wish to use for term searches. head over to [Dictionary](../dictionaries//index.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. + +custom dictionaries list + +### Scanning Text + +Webpage text can be scanned by moving the cursor while holding a modifier key, which is Shift by default. + +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. + +popup with search terms + +### Audio + +Click on the loudspeaker icon _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). +