Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Convert 1-file docs to epub with TOC #1981

Closed
evb0110 opened this issue Apr 30, 2018 · 12 comments
Closed

Convert 1-file docs to epub with TOC #1981

evb0110 opened this issue Apr 30, 2018 · 12 comments
Assignees
Labels
external Depends on another ticket (likely in another repo) wishlist "nice to have" issues; might require a lot of work or a big change or be low priority

Comments

@evb0110
Copy link

evb0110 commented Apr 30, 2018

The problem

It would be very convenient to have the whole docs file in epub (or mobi, or fb2) format to use it on Kindles and other e-ink devices. The crucial thing is to convert the documents multilevel structure into epub/mobi's bookmarks, otherwise it's impossible to navigate a file of several thousand kindle screens.

Suggestions

To have epub/mobi versions of the docs with TOC, which should be kept up-to-date to reflect current updates to the docs.

@tisonkun tisonkun assigned tisonkun and unassigned tisonkun May 1, 2018
@JJ
Copy link
Contributor

JJ commented May 2, 2018

Converting HTML to epub is relatively straightforward; generating a table of contents is not big deal either. However, creating a concept index could be a problem, because the generated HTML links do not seem to be compatible with ePub. Would the first be OK?

@tisonkun
Copy link
Member

tisonkun commented May 2, 2018

Treat index as an item of toc. Be an appendix.

@JJ
Copy link
Contributor

JJ commented May 2, 2018 via email

@JJ
Copy link
Contributor

JJ commented May 2, 2018 via email

@evb0110
Copy link
Author

evb0110 commented May 2, 2018

I always navigate an epub with TOC, and when I make epub with calibre from html, there are usually problems with multi-level TOC.

@JJ
Copy link
Contributor

JJ commented May 2, 2018 via email

@evb0110
Copy link
Author

evb0110 commented May 2, 2018

For me — no, I can live without them, especially on Kindle.

@AlexDaniel AlexDaniel assigned AlexDaniel and unassigned AlexDaniel May 4, 2018
@JJ JJ added wishlist "nice to have" issues; might require a lot of work or a big change or be low priority external Depends on another ticket (likely in another repo) labels May 14, 2018
@FCO
Copy link

FCO commented Apr 3, 2019

I don’t know if it’s my iphone’s Issue, but the ePub version is all blank for me...

@JJ
Copy link
Contributor

JJ commented Apr 3, 2019 via email

@JJ JJ closed this as completed in 7906e05 Apr 8, 2019
@JJ
Copy link
Contributor

JJ commented May 17, 2020

Since the bigpage target has been eliminated because it does not work now, I'm reopening this issue to get it to work again...

@mendel
Copy link
Member

mendel commented Aug 29, 2020

I managed to generate the "bigpage" HTML with a patched pod2bigpage: perl6/perl6-pod-to-bigpage#36. Apparently in the meantime the epub and bigpage Makefile targets were removed as broken, so those need to be restored, too: #3599.

@coke coke self-assigned this May 24, 2022
@coke
Copy link
Collaborator

coke commented Feb 4, 2023

Raku/doc-website#75

@coke coke closed this as completed Feb 4, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
external Depends on another ticket (likely in another repo) wishlist "nice to have" issues; might require a lot of work or a big change or be low priority
Projects
None yet
Development

No branches or pull requests

7 participants