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

Provide offline version of the documentation #38

Open
alphamodh0 opened this issue Jan 21, 2022 · 2 comments
Open

Provide offline version of the documentation #38

alphamodh0 opened this issue Jan 21, 2022 · 2 comments

Comments

@alphamodh0
Copy link

In countries like mine, the internet connection is not something that is easy to get or very cheap, so having a help and needing to be connected every time it is needed would be great.

@probonopd
Copy link
Member

probonopd commented Jan 23, 2022

This would require us to put a copy of the HTML assets onto the ISO. Should be doable. However, this would also mean that the copy shipping with the OS would be outdated most of the time, because often we update the documentation only after a new major version of the OS has been released.

Maybe it would be sufficient to have a download for the latest version (at the time of the download). We could offer PDF and/or EPUB.

Possibly also https://github.com/hynek/doc2dash could be used to create a docset which could be viewed by Zeal.

@probonopd probonopd transferred this issue from helloSystem/Utilities Jan 23, 2022
@probonopd probonopd changed the title Make Help.app an Offline app. Provide offline version of the documentation Jan 23, 2022
@probonopd
Copy link
Member

probonopd commented Jan 23, 2022

Actually it looks like we are already generating an EPUB but it does not get deployed to GitHub Releases yet.

https://github.com/helloSystem/docs/runs/4857046404?check_suite_focus=true#step:3:994

The ePub file is in _build/epub.

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

No branches or pull requests

2 participants