Skip to content

Commit

Permalink
Merge pull request #56 from jamesmaa/update-oct
Browse files Browse the repository at this point in the history
Some changes
  • Loading branch information
jamesmaa authored Oct 19, 2024
2 parents f8407ee + fccbe53 commit 3bc4022
Show file tree
Hide file tree
Showing 10 changed files with 51 additions and 25 deletions.
1 change: 1 addition & 0 deletions docs/contributing/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Looking to contribute back to the Yomitan community? Read [this document](https://github.com/yomidevs/yomitan?tab=readme-ov-file#contributing) to see how you can help improve Yomitan for thousands of users.
7 changes: 2 additions & 5 deletions docs/getting-started/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,7 @@ hide:

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!

!!! note "Migrating from Yomichan? Learn how to migrate to Yomitan [here](../yomichan-migration.md)"
---

## Installation
Expand Down Expand Up @@ -63,7 +60,7 @@ Click the <img class="icon" src="../assets/icon/yomitan-icon.svg" width="16" hei

### 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 [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.

Expand Down
4 changes: 2 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ hide:

## What is Yomitan?

Yomitan turns your web browser into a tool for building language literacy by helping you **read** texts that would otherwise be too difficult to tackle in [a variety of supported languages](./other/supported-languages.md).
Yomitan turns your web browser into a tool for building language literacy by helping you **read** texts that would otherwise be too difficult to tackle in [a variety of supported languages](./supported-languages.md).

<div class="grid cards" markdown>

Expand Down Expand Up @@ -70,7 +70,7 @@ Yomitan turns your web browser into a tool for building language literacy by hel

---

[:octicons-arrow-right-24: Supported languages](./other/supported-languages.md)
[:octicons-arrow-right-24: Supported languages](./supported-languages.md)

- :pencil:{ .lg .middle } &nbsp;
__Flashcards__
Expand Down
File renamed without changes.
17 changes: 17 additions & 0 deletions docs/stylesheets/extra.css
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
p {
margin-block-start: 0.5em;
margin-block-end: 0.5em;
}

.md-button--stretch {
width: 100%;
text-align: center;
Expand Down Expand Up @@ -30,3 +35,15 @@
.icon:hover {
top: -1px;
}

.md-typeset h1 {
margin: 0 0 0.5em;
}

.md-main__inner {
margin-top: 0.5rem;
}

.md-typeset {
line-height: 1.5;
}
16 changes: 15 additions & 1 deletion docs/other/faq.md → docs/support/index.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,23 @@
---
hide:
- toc
- navigation
- footer
- toc
---

Having trouble with Yomitan? If you don't find your answers here, feel free to reach out to us in the following communities.

## Yomitan Discord

We have an active community of users and collaborators on our discord server.

[![](https://img.shields.io/discord/308323056592486420?style=for-the-badge&label=Discord%20Chat&color=bc00ff)](https://discord.gg/eCKjNuXW)


## Github

You can [file an issue in our github repository here](https://github.com/yomidevs/yomitan/issues/new/choose) and provide any context that could help us help you resolve your issue.

## Frequently Asked Questions

**I can't scan text in Firefox!**
Expand Down
File renamed without changes.
15 changes: 7 additions & 8 deletions docs/community/index.md → docs/supporting-tools.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,24 +4,23 @@ hide:
- footer
---

## Community
A compiled list of software that improves your Yomitan experience.

This section will be a compiled list of software that works well with, or community tooling made for Yomitan.

### Compatible Software

#### [Anki](https://apps.ankiweb.net/)

See the dedicated [Anki](../anki/index.md) section.
### Media players

#### [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).

### Readers

#### [Ttsu Reader](https://reader.ttsu.app/)

An online e-book reader that works flawlessly with Yomitan.

#### [PDF Reader](yomitan-pdf-viewer/index.html)
Reading PDF's in your browser that is Yomitan-scannable

### Community Tooling

!!! warning "These are not made nor maintained by Yomitan developers, and it may break Yomitan's functionalities."
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ hide:
- footer
---

## Migrating from Yomichan
# Migrating from Yomichan

### Exporting Data

Expand Down
14 changes: 6 additions & 8 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,9 @@ nav:
- Dictionaries: 'dictionaries/index.md'
- Anki: 'anki/index.md'
- Advanced Features: 'advanced/index.md'
- Community: 'community/index.md'
- PDF Viewer: 'yomitan-pdf-viewer/index.html'
- Other:
- FAQ: 'other/faq.md'
- Browser permissions: 'other/permissions.md'
- Supported languages: 'other/supported-languages.md'
- Migrating from Yomichan (legacy): 'other/yomichan-migration.md'
- Supporting Tools: 'supporting-tools.md'
- Tech Support: 'support/index.md'
- Contributing: 'contributing/index.md'
theme:
name: material
favicon: assets/icon/yomitan-icon64.png
Expand Down Expand Up @@ -103,4 +99,6 @@ plugins:
extra_css:
- stylesheets/extra.css

copyright: Copyright &copy; 2024 Yomitan Authors
copyright: |
Copyright &copy; 2024 Yomitan Authors <br>
<a href="https://yomitan.wiki/privacy">Privacy and Permissions</a>

0 comments on commit 3bc4022

Please sign in to comment.