So zeigen Sie die Codedokumentation mit Zeal offline an

Wenn Sie Code geschrieben haben, stimmen Sie wahrscheinlich zu, dass das Programmieren das Lesen von Dokumentation umfasst, und zwar viel davon. In vielen Fällen übersteigt die Zeit, die für das Lesen von Dokumentation und anderem Code aufgewendet wird, die tatsächliche Zeit für das Schreiben von Code. Und da auf diese Dokumentation meistens im Web zugegriffen wird, wird ein erheblicher Teil der Zeit damit verschwendet, die gesuchten Informationen zu finden und darauf zu warten, dass sie geladen werden. Diese kleinen Verzögerungen können frustrierend sein, insbesondere bei langsameren Verbindungen, und können schnell zu einem Produktivitätsverlust von Minuten oder Stunden führen. Außerdem ist für den Zugriff auf diese Informationen eine ständige Internetverbindung erforderlich, die nicht immer verfügbar ist.

Glücklicherweise können Sie Zeal, einen Offline-Dokumentationsbrowser, verwenden, um Programmiersprachen- und Softwaredokumentationen auf Ihrem Computer zu speichern und schnell und effektiv darauf zuzugreifen. Eifer verwendet Dokumentensätze (docsets), die von . bereitgestellt werden Bindestrich. Sie beinhalten Dokumentationen für viele Programmier- und Skriptsprachen und Bibliotheken sowie verschiedene Software wie Docker, Nginx, WordPress und ElasticSearch, um nur einige zu nennen.

So installieren, verwenden und passen Sie Zeal unter Linux an.

Eifer installieren

Zeal ist in den Software-Repositorys vieler Linux-Distributionen verfügbar, daher sollten Sie es nach Möglichkeit mit Ihrem nativen Paketmanager installieren.

Unter Ubuntu, Linux Mint und Debian:

sudo apt install zeal

Unter Arch-Linux:

sudo pacman -S zeal

Auf Gentoo:

sudo emerge app-doc/zeal

Auf Fedora:

sudo dnf install zeal

Eifer verwenden

Sie können Zeal über Ihr Anwendungsmenü/Startprogramm oder über ein Befehlszeilenterminal starten, indem Sie eingeben zeal.

Zeal enthält standardmäßig keine Dokumentation. Um die verfügbaren Docsets anzuzeigen, gehen Sie zu „Extras -> Docsets“ und öffnen Sie die Registerkarte „Verfügbar“.

Wählen Sie die zu speichernden Dokumentensätze aus und klicken Sie auf „Herunterladen“. Nach dem Abrufen werden Dokumentensätze im oberen linken Bereich in einer navigierbaren hierarchischen Struktur angezeigt. Im unteren linken Bereich werden ggf. Verknüpfungen zu den Elementen der aktuellen Dokumentseite angezeigt.

Sie können alle Docsets durchsuchen, indem Sie eine Abfrage oder ein bestimmtes Docset mit der Syntax eingeben docset:query. Um zum Beispiel nach Pythons zu suchen re.match Funktion würden Sie eingeben python:re.match.

Notiz: mit der zusammengesetzten Suchsyntax (also docset:query), das docset Beim Teil muss die Groß-/Kleinschreibung beachtet werden query Bei einem Teil wird die Groß-/Kleinschreibung nicht beachtet.

Eifer anpassen

Schriftarten

Sie können das Erscheinungsbild von Zeal mit Schriftarten und Schriftgrößen nach Ihren Wünschen konfigurieren.

Gehen Sie dazu zu „Bearbeiten -> Einstellungen -> Inhalt“ und wählen Sie dann eine Standard-Schriftfamilie und bestimmte Schriftarten für jede Schriftfamilie aus.

Dunkler Modus

Zeal bietet auch einen Dunkelmodus (in „Bearbeiten -> Einstellungen -> Inhalt“), der jedoch nur auf Dokumentinhalte und nicht auf die umgebende grafische Oberfläche angewendet wird, wie Sie im folgenden Screenshot sehen können.

Benutzerdefiniertes CSS

Wenn Sie Zeal regelmäßig verwenden, lohnt es sich, etwas Zeit zu investieren, um es an Ihren eigenen Geschmack anzupassen. Sie können ein benutzerdefiniertes Stylesheet verwenden, um das Erscheinungsbild von Dokumenten besser und genauer zu steuern.

Erstellen Sie mit Ihrem Texteditor eine neue CSS-Datei:

vim ~/.local/share/Zeal/custom.css

Geben Sie die gewünschten CSS-Regelsätze ein, zum Beispiel:

code {
border-style: dashed;
border-width: 1px;
color: red;
}

Gehen Sie zur Datei „Bearbeiten -> Einstellungen -> Inhalt -> Benutzerdefiniertes CSS“, um die neu erstellte CSS-Datei auszuwählen. Nach dem Speichern Ihrer Einstellungen sind die Änderungen sofort sichtbar. Der folgende Screenshot zeigt Zeal nach der Anwendung des obigen CSS.

Fazit

Zeal ist ein großartiges Werkzeug für Programmierer und Systemadministratoren, die häufig auf Dokumentationen zugreifen. Da Dokumente lokal gespeichert werden, können Sie Zeit sparen und sich besser auf die anstehende Arbeit konzentrieren. Darüber hinaus unterstützt es im Gegensatz zu Webdokumenten benutzerdefinierte Stylesheets für eine genaue Kontrolle über das Erscheinungsbild des Dokuments.