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

feat: add script to generate ebook #1232

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

FineFindus
Copy link

Closes #1070.

I wanted to read this book on my e-reader, so I added a quick script, to generate an e-book from the markdown, using pandoc. This is not perfect, the issues include:

  • Some of the used syntax breaks the e-book, so it needs to be removed
  • Links, that link to the website (e.g. all links starting with @) do not work. Preferably, they would link to the chapter in the book, but I'm not sure how to do that.
  • The layout is often imperfect, code blocks or text diagrams may be split over pages
  • No real differentiating between posts
  • New chapters do not start on a new page
  • probably another dozen of things I didn't notice

I'm not sure how many of them can be fixed without changing the source content itself, or how to fix most of them, but I think this is a worthwhile start, as it is still readable (an e-book with bad layout is still better than no e-book).

Also added a quick cover image, I'm not a designer, but it gets the job done. Maybe another contributor, with better design skills, can improve it.

@phil-opp
Copy link
Owner

phil-opp commented Sep 6, 2023

Thanks a lot for submitting! Unfortunately I'm quite busy right now and I haven't had time to review this PR and to try it out. I try my best to get to it as soon as possible!

@FineFindus
Copy link
Author

You're welcome. That's absolutey no problem for me, take your time. In the meantime, I've had time to read through it, using the generated e-book, and noticed a few more issues. Most of them were probably caused by my device, as they do not appear when opening the e-book on my pc, but I think it is still worth mentioning them:

  • Code was not line-wrapped, so it sometimes went off-page
  • Text was missing in images, which made diagrams unreadable

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Feature Request: EPUB
2 participants