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

Any plans to convert this material to ebook format such as epub? #14

Open
mitochondrion opened this issue Nov 20, 2022 · 4 comments
Open
Assignees
Labels
enhancement New feature or request

Comments

@mitochondrion
Copy link

The content is great, but it would be nice if it could be read on an e-reader, which is highly preferable vs a mobile phone for long-form reading for some folks. Any plans to convert it? Epub would be great as it is standard and easily convertible to other formats. Thanks!

@claymcleod claymcleod self-assigned this Nov 21, 2022
@claymcleod claymcleod added the enhancement New feature or request label Nov 21, 2022
@claymcleod
Copy link
Member

Good question! I looked at the docusaurus docs and didn't find anything immediately available to convert these to PDF/epub. That said, I'd happily take a PR on it if you had some inspiration on how it could be done!

@cmdcolin
Copy link

I have a method that I use with our (jbrowse) docs to make PDF from docusaurus. Basically it uses the "sidebar.json" as a guide to creating the order of pages, and performing markdown->pdf using pandoc+latex. Possibly could do epub with pandoc too

@cmdcolin
Copy link

Looks like sidebar in this repo doesn't provide as much order but same concept could possibly apply

@cmdcolin
Copy link

The quick hacked-together version of this looks like https://github.com/cmdcolin/learngenomics.dev/tree/pdf

(run make in build directory)

creates this pdf

learngenomics.pdf

Some quick notes

-info boxes are not handled
-some code boxes overflow
-some tables are cramped

these are generally hard design constraints in latex that can probably get workarounds

I also use a "Figure component" in the markdown to allow figures to have captions. Markdown doesn't generally have a good notion of caption, just the only has alt text in square brackets, but in pandoc, the "alt text" becomes captions in pdf so I made the custom "Figure component" to render those same captions on the web

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

No branches or pull requests

3 participants