Most documentation tools export static HTML. MkDocs, Sphinx, Docusaurus, Hugo, a generated API reference: the result is a self-contained folder, designed to work with no connection. That is exactly what you want on a plane, in a datacentre basement, or at a client whose wifi refuses your laptop.
All that is left is opening it on the tablet you brought.
Why PDF is not the answer
The reflex is to export the documentation to PDF. It works, and for a short document it is often the right call. But technical documentation loses a lot in the conversion.
- The sidebar navigation disappears, replaced by a scroll through several hundred pages.
- Links between sections become page references at best, dead text at worst.
- Syntax highlighting and collapsible code blocks do not always survive.
- Every update means redoing the export.
Meanwhile the HTML export already exists, and it contains all of that.
Keeping the documentation as it was generated
Pagira opens the export folder the way a browser would: the sidebar, the links between pages, the code highlighting. You consult the documentation, not a photograph of it.
- Copy the export folder into Files or iCloud Drive.
- Open it with Pagira.
- Navigate as you would on the site: the toolbar gives you back, forward and reload.
iCloud Drive, and the offline question
Generated documentation often runs to several hundred megabytes, images and fonts included. Sitting in iCloud Drive, it streams as you read, with no wait before the first page appears.
Before a trip, download a permanent offline copy. The download is resumable, so a dropped connection does not start over, and a banner makes clear what stays available with no network. See streaming from iCloud Drive or saving offline.
Preparing the pages you will need
There is offline you suffer and offline you prepare. If you already know which documents you will consult, download them for offline reading before leaving, and add the most useful ones to your favorites: they are waiting for you on Home, and each one reopens at the page where you left it. See favorites.
The case of mixed documentation
Corporate documentation almost always mixes HTML pages and PDFs: a specification, an architecture diagram, a contractual appendix. Both open in the same app, and a link from a page to a PDF opens in place.
FAQ
What about documentation running to several gigabytes?
Streaming from iCloud avoids having to download it all at once. For full offline access, the limit is the space available on the device.
My documentation is confidential
Nothing is sent anywhere. Everything renders locally, which is precisely the argument against an online document viewer.
Can I read it on iPhone too?
Yes, one app covers both. With iCloud, the page you are on and your favorites follow you from one device to the other, for documents stored in iCloud Drive.
How do I open it from another tool?
Through the share sheet, with Open with Pagira, from Files or from any app. See open from anywhere.
