Back to the blog

Reading Technical Documentation Offline on iPad

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.

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.

  1. Copy the export folder into Files or iCloud Drive.
  2. Open it with Pagira.
  3. 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 sections you will consult, save them to the reading list before leaving. Each item is kept as a complete snapshot rather than a bookmark, so it stays readable even if the source folder moves. See the reading list.

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, and recent items let you pick up a document started on the other device.

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.