Skip to content

Commit

Permalink
Deployed 6139c97 with MkDocs version: 1.6.1
Browse files Browse the repository at this point in the history
  • Loading branch information
Unknown committed Sep 17, 2024
1 parent dddd857 commit 7a4493c
Show file tree
Hide file tree
Showing 14 changed files with 12 additions and 1,018 deletions.
Binary file not shown.
Binary file removed assets/resources/browser-action-popup2.webp
Binary file not shown.
Binary file removed assets/resources/search-popup-kanji-thumb.webp
Binary file not shown.
Binary file removed assets/resources/search-popup-kanji.webp
Binary file not shown.
Binary file removed assets/resources/search-popup-terms-thumb.webp
Binary file not shown.
Binary file removed assets/resources/search-popup-terms.webp
Binary file not shown.
Binary file not shown.
Binary file removed assets/resources/settings-dictionaries-popup.webp
Binary file not shown.
File renamed without changes.
24 changes: 11 additions & 13 deletions getting-started/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -594,9 +594,9 @@
</li>

<li class="md-nav__item">
<a href="#kanji" class="md-nav__link">
<a href="#anki" class="md-nav__link">
<span class="md-ellipsis">
Kanji
Anki
</span>
</a>

Expand Down Expand Up @@ -961,9 +961,9 @@
</li>

<li class="md-nav__item">
<a href="#kanji" class="md-nav__link">
<a href="#anki" class="md-nav__link">
<span class="md-ellipsis">
Kanji
Anki
</span>
</a>

Expand Down Expand Up @@ -994,7 +994,7 @@

<h1>Getting started</h1>

<p>This introduction will help you quickly familiarize yourself with the basics and set you up for a smooth language learning experience. </p>
<p>This introduction will help you quickly familiarize yourself with the basics and set you up for a smooth language learning experience.</p>
<p>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.</p>
<p>Let's dive in and get started!</p>
<hr />
Expand All @@ -1019,27 +1019,25 @@ <h2 id="basic-usage">Basic Usage</h2>
<p>Now that you have installed Yomitan, let's explore how you can utilize her features in your language learning journey.</p>
<h3 id="quick-actions">Quick-actions</h3>
<p>Click the <img src="../assets/icon/yomitan-icon.svg" width="16" height="16" alt="yomitan icon"> <em>Yomitan</em> button in the browser bar to open the quick-actions popup.</p>
<p><img src="../assets/resources/browser-action-popup1.webp" alt="yomitan main popup"></p>
<p><img src="../assets/ss/browser-action-popup.webp" alt="yomitan main popup"></p>
<ul>
<li>The <img src="../assets/icon/cog.svg" width="16" height="16" alt="cog"> <em>cog</em> button will open the Settings page.</li>
<li>The <img src="../assets/icon/magnifying-glass.svg" width="16" height="16" alt="magnifying glass"> <em>magnifying glass</em> button willopen the Search page.</li>
<li>The <img src="../assets/icon/question-mark-circle.svg" width="16" height="16" alt="question mark symbol"> <em>question mark</em> buttonwill open the Information page.</li>
<li>The <img src="../assets/icon/profile.svg" width="16" height="16" alt="profile icon"> <em>profile</em> button will appear when multipleprofiles exist, allowing the current profile to be quickly changed.</li>
</ul>
<h3 id="installing-dictionaries">Installing Dictionaries</h3>
<p>To import the dictionaries you wish to use for term and kanji searches, head over to <a href="../dictionaries/">Dictionary</a> to get set up!</p>
<p>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.</p>
<p><img src="../assets/resources/settings-dictionaries-popup.webp" width="300" alt="custom dictionaries list"></p>
<p>To import the dictionaries you wish to use for term searches. head over to <a href="../dictionaries/">Dictionary</a> to get set up!</p>
<p>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.</p>
<p><img src="../assets/ss/settings-dictionaries-popup-english.webp" width="300" alt="custom dictionaries list"></p>
<h3 id="scanning-text">Scanning Text</h3>
<p>Webpage text can be scanned by moving the cursor while holding a modifier key, which is <kbd>Shift</kbd> by default.</p>
<p>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.</p>
<p><img src="../assets/resources/search-popup-terms.webp" width="300" alt="popup with search terms"></p>
<p><img src="../assets/ss/search-popup-terms-english.webp" width="300" alt="popup with search terms"></p>
<h3 id="audio">Audio</h3>
<p>Click on the <img src="../assets/icon/play-audio.svg" width="16" height="16" alt="loudspeaker icon"> <em>speaker</em> button to hear the term pronounced by a native speaker.</p>
<p>If an audio sample is not available, you will hear a short click instead. For more options, see <a href="../advanced/#audio">Audio Configuration</a>.</p>
<h3 id="kanji">Kanji</h3>
<p>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.</p>
<p><img src="../assets/resources/search-popup-kanji.webp" width="300" alt="popup with kanji details"></p>
<h3 id="anki">Anki</h3>
<p>To further enhance your Yomitan experience, it's worth <a href="../anki/">integrating with Anki</a>, a spaced-repetition flashcard program to help solidify the words you encounter.</p>


Expand Down
Loading

0 comments on commit 7a4493c

Please sign in to comment.