search

helloSystem / docs

This repository builds the documentation for hello
https://hellosystem.github.io/docs/
BSD 2-Clause "Simplified" License
20 stars 22 forks source link

Provide offline version of the documentation #38

Open alphamodh0 opened 2 years ago

alphamodh0 commented 2 years ago

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 commented 2 years ago

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 commented 2 years ago

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.