Skip to content
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

Fix bad page #46

Merged
merged 3 commits into from
Sep 17, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file removed docs/assets/resources/browser-action-popup2.webp
Binary file not shown.
Binary file removed docs/assets/resources/search-popup-kanji-thumb.webp
Binary file not shown.
Binary file removed docs/assets/resources/search-popup-kanji.webp
Binary file not shown.
Binary file removed docs/assets/resources/search-popup-terms-thumb.webp
Binary file not shown.
Binary file removed docs/assets/resources/search-popup-terms.webp
Binary file not shown.
Binary file not shown.
Binary file not shown.
26 changes: 13 additions & 13 deletions docs/getting-started/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,7 @@ hide:
- footer
---


This introduction will help you quickly familiarize yourself with the basics and set you up for a smooth language learning experience.
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.

Expand All @@ -16,17 +15,20 @@ 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: 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 }

Expand All @@ -35,11 +37,13 @@ Let's dive in and get started!
<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-brands-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
Expand All @@ -50,7 +54,7 @@ Now that you have installed Yomitan, let's explore how you can utilize her featu

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">
<img src="../assets/ss/browser-action-popup.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.
Expand All @@ -59,30 +63,26 @@ Click the <img src="../assets/icon/yomitan-icon.svg" width="16" height="16" alt=

### Installing Dictionaries

To import the dictionaries you wish to use for term and kanji 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 [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.
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.webp" width="300" alt="custom dictionaries list">
<img src="../assets/ss/settings-dictionaries-popup-english.webp" 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.webp" width="300" alt="popup with search terms">
<img src="../assets/ss/search-popup-terms-english.webp" 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).

### Kanji

Click on individual kanji in the term definition results to view additional information about those characters, including stroke order diagrams, readings, meanings, and other useful data.

<img src="../assets/resources/search-popup-kanji.webp" width="300" alt="popup with kanji details">
### 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.
81 changes: 0 additions & 81 deletions docs/getting-started/non_ja_example.md

This file was deleted.