Skip to content

Commit

Permalink
docs: epub reader
Browse files Browse the repository at this point in the history
  • Loading branch information
gotson committed Jan 27, 2025
1 parent 8362d59 commit 030806f
Show file tree
Hide file tree
Showing 6 changed files with 87 additions and 6 deletions.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Read with the Webreader
# Read with the Webreader: DIVINA

Komga has an integrated Webreader packed with features.
Komga has an integrated Webreader packed with features for DIVINA (Digital Visual Narrative) books.

To start reading a book, you can click on the read button either on the book card, or on the book details screen.

Expand All @@ -11,7 +11,7 @@ To start reading a book, you can click on the read button either on the book car
Here is an overview of the Webreader's interface.

<a href="/assets/media/guides/webreader/reader.png">
<img src="/assets/media/guides/webreader/reader.png" alt="Webreader overview"/>
<img src="/assets/media/guides/webreader/reader.png" alt="Webreader DIVINA overview"/>
</a>

## Settings
Expand All @@ -30,7 +30,7 @@ Four reading modes are available:
- Vertical
- Webtoon: displays all the pages in a continuous vertical strip

The Webreader will automatically use the _Reading direction_ specified in the Book metadata.
The Webreader will automatically use the _Reading direction_ specified in the Book metadata.

#### Animate page transitions

Expand All @@ -44,7 +44,7 @@ Touch gestures are available in the Page reader only (Left to right, Right to le

#### Background color

You can choose the background color of the reader between white and black.
You can choose the background color of the reader between white, gray, and black.

### Reader specific options: Paged reader

Expand Down
80 changes: 80 additions & 0 deletions website/docs/guides/webreader-epub.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
# Read with the Webreader: EPUB

Komga has an integrated Webreader packed with features for EPUB books.

To start reading a book, you can click on the read button either on the book card, or on the book details screen.

<img src="/assets/media/guides/webreader/book-card.png" style={{maxHeight: '300px'}} alt="Book Card Read Button"/>

<img src="/assets/media/guides/webreader/read-button.png" style={{maxHeight: '300px'}} alt="Book Details read button"/>

Here is an overview of the Webreader's interface.

<a href="/assets/media/guides/webreader/reader-epub-overview.png">
<img src="/assets/media/guides/webreader/reader-epub-overview.png" alt="Webreader EPUB overview"/>
</a>

## Settings

The Webreader can be configured in various ways from the settings dialog.

<img src="/assets/media/guides/webreader/reader-epub-settings.png" style={{maxHeight: '400px'}} alt="Webreader EPUB settings"/>

### General

#### Always full screen

The reader will always start in full screen, and exit full screen when you exit from the reader.

#### Navigation mode

Navigate between pages using the buttons shown on screen, by taping/clicking, or both.

### Display

#### Font

Choose the font used to display the text. The _Publisher_ font is included with the book.

Additional fonts can be installed on the server:
1. Create a new `fonts` directory in the Komga configuration directory.
2. Create 1 sub-directory for each font family you want to add, for example `Liberation`.
3. Add all the fonts files in the sub-directory.
Komga will recognize the following extensions: `otf`, `ttf`, `woff`, and `woff2`.
Komga will recognize the following keywords in file names: `bold` and `italic`, and categorize the fonts accordingly.

An example file structure would be:
```
config/
fonts/
LiberationSerif-Bold.ttf
LiberationSerif-BoldItalic.ttf
LiberationSerif-Italic.ttf
LiberationSerif-Regular.ttf
```

#### Viewing theme

You can choose the background color of the reader between white and black.

#### Layout

Two layouts are available:
- Scroll
- Paginated

#### Column count (Paginated layout only)

Choose the number of columns of text to display.

#### Text size & line spacing

Increase or decrese the text size and line spacing.

#### Page margins

You can increase the size of the margins.

## Help dialog

The help dialog will display the available keyboard shortcuts. The dialog is context-aware, and will only show shortcuts that are relevant to the current reading mode.
3 changes: 2 additions & 1 deletion website/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,8 @@ const sidebars = {
type: 'generated-index',
},
items: [
'guides/webreader',
'guides/webreader-divina',
'guides/webreader-epub',
'guides/mihon',
'guides/komelia',
'guides/kobo',
Expand Down
Binary file modified website/static/assets/media/guides/webreader/read-button.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 030806f

Please sign in to comment.