Skip to content

Commit

Permalink
Add Docs Explaining Adding Dictionary CSS Files (#1180)
Browse files Browse the repository at this point in the history
* Explain Adding Dictionary CSS Files

* Fix Test Dict Link
  • Loading branch information
MarvNC authored Jul 8, 2024
1 parent 327415b commit 8296656
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs/making-yomitan-dictionaries.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,10 @@ Below is a list of Yomitan dictionary schemas, their expected filenames, and the
| [`dictionary-term-bank-v3-schema.json`](https://github.com/themoeway/yomitan/tree/master/ext/data/schemas/dictionary-term-bank-v3-schema.json) | `term_bank_${number}.json` | Stores dictionary readings, definitions, etc. |
| [`dictionary-term-meta-bank-v3-schema.json`](https://github.com/themoeway/yomitan/tree/master/ext/data/schemas/dictionary-term-meta-bank-v3-schema.json) | `term_meta_bank_${number}.json` | Stores meta information about terms, such as frequency data and pitch accent data. |

## Adding Custom CSS

You can add custom CSS to a dictionary simply by adding a `styles.css` file to the root of the dictionary zip archive. This file will be loaded by Yomitan and applied to the dictionary viewer with the styles scoped to the dictionary. For example, observe the `styles.css` file in the [official test dictionary](https://github.com/themoeway/yomitan/tree/master/test/data/dictionaries/valid-dictionary1).

## Packaging A Dictionary

A dictionary can contain various types of information within the zip file. After creating an `index.json` and the relevant data files, zip them with all data `.json` files in the root directory of the zip, not in subfolders. Use the highest compression level possible to reduce the size.
Expand Down

0 comments on commit 8296656

Please sign in to comment.