Zum Inhalt springen →

Flutter Docs – Offline Copy

Foto von Kristopher Roller

Heute habe ich mal wieder viel an meinem aktuellen Flutter Projekt gearbeitet und versucht, so viel wie möglich vorzubereiten um in den nächsten Tagen in der Bahn wieder möglichst problemlos offline in der Bahn arbeiten zu können, denn leider ist es so, dass ich viele Fragen ohne das Internet noch nicht lösen kann. Source-Code lesen ist im Fall von Flutter und Dart zwar einfach möglich, aber nicht immer so effizient. Daher habe ich mir einfach mal die HTML-Doku Dateien offline generiert, die man z.B. unter „https://api.flutter.dev/“ finden kann.

Flutter offline Docs generieren

Das generieren der offline Flutter docs ist recht einfach. Dazu benötig man nur eine Flutter-Installation und eine Shell (Unter Linux und MAcOS ist eine Shell dabei, unter Windows kann man z.B. die git-Bash verwenden, die auch jeder Entwickler installiert haben sollte – Ausführliche Infos zur git-Bash kann man in meinem Beitrag Magie mit der git bash nachlesen). Im Verzeichnis „flutter/dev/bots“ findest Du eine Datei mit dem Namen docs.sh. Wenn Du die Datei ausführst, musst Due eine Weile warten. Danach findest Du unter „flutter/dev/docs/doc/api“ die API-Doku zur aktuell installierten Flutter Installation.

Flutter oflline docs

Die generierten Flutter API-Docs sind aktuell (Flutter (Channel stable, v1.12.13+hotfix.8) ca. 1.6 GB groß und enthalten etwa 68.000 HTML-Dokumente und eine Handvoll JavaScript und CSS Dateien.

Die im Hauptverzeichnis enthaltene index.html Datei kann man im Browser aufrufen und von Dort durch die komplette Dart und Flutter Doku navigieren. Allerdings gibt es auch Einschränkungen. So funktioniert z.B. die Suche oben rechts nicht. Statt „Search API Docs“ steht dort nur „Error loading search index“. Ausserdem werden in den Docs auch Youtube-Videos und andere online Ressourcen eingebunden die natürlich auch nicht offline verfügbar sind. So hat man leider offline nur einen begrenzten Zugriff auf die Doku

Flutter oflline docs herunterladen

Wer sich nicht die Mühe machen möchte, die Flutter Offline Doku selber zu generieren, oder keine Möglichkeit hat das docs.sh Skript aufzurufen, kann die von mir generierten Dokumente auch als gepackte Datei (ca. 100MB) herunterladen.

Die von mit generieren Flutter API-Docs basieren auf Flutter (Channel stable, v1.12.13+hotfix.8) und können unter https://jentsch.io/wp-content/uploads/2020/03/flutter-docs-v1.12.13+hotfix.8.tgz heruntergeladen werden.

Veröffentlicht in Allgemein