-
Notifications
You must be signed in to change notification settings - Fork 8
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
fixed link issues and added non ja example for walkthrough #40
Changes from 1 commit
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Is the only difference the screenshots? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. yes and I removed the kanji section + mentions of japanese, I wasn't sure if there was anything else that was different between using japanese and not using japanese. |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 | ||
<div class="grid" markdown> | ||
|
||
[:fontawesome-brands-chrome: Get Yomitan <small>Chrome/Stable</small>](https://chrome.google.com/webstore/detail/yomitan/likgccmbimhjbgkjambclfkhldnlhbnn){ .md-button .md-button--primary .md-button--stretch } | ||
|
||
[:fontawesome-brands-chrome: Get Yomitan <small>Chrome/Beta</small>](https://chrome.google.com/webstore/detail/yomitan-development-build/glnaenfapkkecknnmginabpmgkenenml){ .md-button .md-button--primary .md-button--stretch } | ||
</div> | ||
|
||
### Firefox | ||
<div class="grid" markdown> | ||
|
||
[:fontawesome-brands-firefox-browser: Get Yomitan <small>Firefox/Stable</small>](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 } | ||
|
||
</div> | ||
|
||
<small>※ 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.</small> | ||
|
||
### Edge | ||
<div class="grid" markdown> | ||
|
||
[:fontawesome=brangs-edge: Get Yomitan <small>Edge/Stable</small>](https://microsoftedge.microsoft.com/addons/detail/yomitan/idelnfbbmikgfiejhgmddlbkfgiifnnn){.md-button .md-button--primary .md-button--stretch} | ||
|
||
</div> | ||
|
||
--- | ||
|
||
## 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 <img 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. | ||
|
||
<img src="../assets/resources/browser-action-popup1.webp" alt="yomitan main popup"> | ||
|
||
- The <img src="../assets/icon/cog.svg" width="16" height="16" alt="cog"> _cog_ button will open the Settings page. | ||
- The <img src="../assets/icon/magnifying-glass.svg" width="16" height="16" alt="magnifying glass"> _magnifying glass_ button willopen the Search page. | ||
- The <img src="../assets/icon/question-mark-circle.svg" width="16" height="16" alt="question mark symbol"> _question mark_ buttonwill open the Information page. | ||
- The <img 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. | ||
|
||
### 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. | ||
|
||
<img src="../assets/resources/settings-dictionaries-popup-english.png" width="300" alt="custom dictionaries list"> | ||
|
||
### Scanning Text | ||
|
||
Webpage text can be scanned by moving the cursor while holding a modifier key, which is <kbd>Shift</kbd> 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. | ||
|
||
<img src="../assets/resources/search-popup-terms-english.png" width="300" alt="popup with search terms"> | ||
|
||
### Audio | ||
|
||
Click on the <img src="../assets/icon/play-audio.svg" width="16" height="16" alt="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). | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Make these
webp
and put them inss/
(screenshots)