Retour au blog

Lire une documentation technique hors-ligne sur iPad

La plupart des outils de documentation exportent en HTML statique. MkDocs, Sphinx, Docusaurus, Hugo, une doc API générée : le résultat est un dossier autonome, conçu pour fonctionner sans connexion. C'est précisément ce qu'il vous faut dans un avion, dans un sous-sol de datacenter ou chez un client dont le wifi refuse votre portable.

Reste à l'ouvrir sur la tablette que vous avez emportée.

Pourquoi le PDF n'est pas la réponse

Le réflexe est d'exporter la documentation en PDF. Cela fonctionne, et pour un document court c'est souvent le bon choix. Mais une documentation technique perd beaucoup à la conversion.

Or l'export HTML existe déjà, et il contient tout cela.

Garder la documentation telle qu'elle a été générée

Pagira ouvre le dossier d'export comme le ferait un navigateur : la barre latérale, les liens entre pages, la coloration du code. Vous consultez la documentation, pas une photographie de la documentation.

  1. Copiez le dossier d'export dans Fichiers ou dans iCloud Drive.
  2. Ouvrez-le avec Pagira.
  3. Naviguez comme sur le site : la barre d'outils donne précédent, suivant et rechargement.

iCloud Drive, et la question du hors-ligne

Une documentation générée pèse souvent plusieurs centaines de mégaoctets, images et polices comprises. Posée dans iCloud Drive, elle se charge à la demande pendant la lecture, sans attente avant l'affichage de la première page.

Avant un déplacement, téléchargez-en une copie hors-ligne permanente. Le téléchargement est reprenable, donc une coupure ne repart pas de zéro, et une bannière indique clairement ce qui reste consultable sans réseau. Voir streaming depuis iCloud Drive ou copie hors-ligne.

Préparer les pages dont vous aurez besoin

Il y a le hors-ligne subi et le hors-ligne préparé. Si vous savez déjà quelles sections vous allez consulter, enregistrez-les dans la liste de lecture avant de partir. Chaque élément est conservé comme un instantané complet et non comme un signet, il reste donc lisible même si le dossier d'origine bouge. Voir la liste de lecture.

Le cas des documentations mixtes

Une documentation d'entreprise mélange presque toujours des pages HTML et des PDF : une spécification, un schéma d'architecture, une annexe contractuelle. Les deux s'ouvrent dans la même app, et un lien depuis une page vers un PDF s'ouvre sur place.

Questions fréquentes

Et une documentation qui pèse plusieurs gigaoctets ?

Le streaming depuis iCloud évite d'avoir à tout télécharger d'un coup. Pour le hors-ligne complet, la limite est l'espace disponible sur l'appareil.

Ma documentation est confidentielle

Rien n'est envoyé. Tout est rendu localement, ce qui est justement l'argument face à un service en ligne d'affichage de documents.

Puis-je la consulter sur iPhone aussi ?

Oui, une seule app couvre les deux, et les éléments récents permettent de reprendre un document commencé sur l'autre appareil.

Comment ouvrir depuis un autre outil ?

Par la feuille de partage, avec « Ouvrir avec Pagira », depuis Fichiers ou depuis n'importe quelle app. Voir ouvrir depuis n'importe où.