Skip to content

Commit

Permalink
Readers
Browse files Browse the repository at this point in the history
Added readers section, put the first draft of ebook reader up. Still need to change some images out.
  • Loading branch information
DieselTech committed Feb 14, 2024
1 parent 38a0b51 commit e155350
Show file tree
Hide file tree
Showing 9 changed files with 52 additions and 5 deletions.
3 changes: 2 additions & 1 deletion pages/guides/_meta.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,9 @@
"3rdparty": "3rd Party Clients",
"external-tools": "External Tools",
"metadata": "Metadata",
"readers": "Readers",
"themes": "Custom Themes",
"scanner": "Library Scanner",
"opds": "OPDS",
"api": "API"
}
}
2 changes: 1 addition & 1 deletion pages/guides/admin-settings/system.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ Under the More Info section are links to Kavita-related websites. [Donations](ht

If you need to [report an issue](https://github.com/Kareadita/Kavita/issues) please visit the GitHub page.

If Kavita is missing a function please visit the [Feature Requests](https://feats.kavitareader.com/) and make a new request, or vote on one you support.
If Kavita is missing a function please visit the [Github Discussions](https://github.com/Kareadita/Kavita/discussions) and make a new request, or vote on one you support.
3 changes: 0 additions & 3 deletions pages/guides/external-tools/komf.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
import { SiTeamcity } from '@icons-pack/react-simple-icons'
import { getModifiedCookieValues } from 'next/dist/server/web/spec-extension/adapters/request-cookies'
import Script from 'next/script'
import { Callout } from 'nextra-theme-docs'
import { Steps } from 'nextra/components'

Expand Down
5 changes: 5 additions & 0 deletions pages/guides/readers/_meta.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"epub": "Book Reader",
"comic-manga": "Comic/Manga Reader",
"pdf": "PDF Reader"
}
Empty file.
44 changes: 44 additions & 0 deletions pages/guides/readers/epub.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
---
title: 'Book Reader'
---
import Image from 'next/image'
import step1 from '../../../public/guides/readers/book-settings.png'
import step2 from '../../../public/guides/readers/book-toc.png'


## Book Reader

Like many other readers, Kavita offers customizations for your reading experience. We offer 7 additional fonts to select from in addition to the fonts that come with the book. Font sizing, line spacing, and margin can all be customized (Margin will default to 0% on mobile devices regardless of your settings).

We offer multiple reading directions and tap to paginate. Tap to Paginate lets you click on the sides of the book rather than having to press the Next/Prev page buttons on the top or bottom of the reader.

The book reader lets you save your settings to your account from within the reader. You are not required to press Save, you can instead adjust it just for that reading session.

## Progress
The book reader will remember approximately where you leave off and will try to restore the scroll position. This will work regardless of what size device you start and resume on.

## Menu Controls
<Image
src={step1}
alt="picture"
width={300}
height={250}
/>

## Table of Contents

<Image
src={step2}
alt="picture"
width={300}
height={250}
/>

Kavita provides a dedicated section in the menu drawer for the table of contents. If a table of contents is not provided in the book metadata, Kavita will attempt to create one by parsing out links and headers in the book itself. As you read, the links will become bold based on where in the page you are. For example, in the image here, I have scrolled down and am on the first part of the first chapter. Notice that the chapter is also bold. You can click on any link to jump instantly to it.

## Inner Links
Some books have links within the reader. Some external and some internal. Kavita does pre-processing before you read and determines if a link is external or not. All external links will open in a new tab. Internal links can be clicked and Kavita will remember the history of links clicked, so you can back out of your nested linking in order by pressing the back button.

## Continuous Reading
The book reader offers a way to stay within the reader and move on to the next book (assuming your book is in a series or a reading list). Like the web reader, we now have buttons to manually click and jump between books. Likewise, when you read the first or last page of the book and there is another book, the Next button will show two arrows implying the pagination will load the next book.

Empty file added pages/guides/readers/pdf.mdx
Empty file.
Binary file added public/guides/readers/book-settings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/guides/readers/book-toc.png
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 e155350

Please sign in to comment.