Jak wyświetlić dokumentację kodu w trybie offline za pomocą Zeal

Jeśli napisałeś jakiś kod, prawdopodobnie zgadzasz się, że programowanie wiąże się z czytaniem dokumentacji, której jest dużo. W wielu przypadkach czas spędzony na czytaniu dokumentacji i innych kodów przekracza rzeczywisty czas pisania kodu. A ponieważ dokumentacja ta jest często dostępna w Internecie, znaczna część czasu jest marnowana na szukanie potrzebnych informacji i oczekiwanie na ich załadowanie. Te małe opóźnienia mogą być frustrujące, szczególnie przy wolniejszych połączeniach, i mogą szybko zwiększyć do minut lub godzin utraconej produktywności. Poza tym do uzyskania dostępu do tych informacji wymagane jest stałe połączenie z Internetem, które nie zawsze jest dostępne,

Na szczęście możesz użyć Zeal, przeglądarki dokumentacji offline, aby przechowywać język programowania i dokumentację oprogramowania na twoim komputerze i uzyskiwać do niego szybki i skuteczny dostęp. Zeal wykorzystuje zestawy dokumentów (docset) dostarczone przez Dziarskość. Obejmują one dokumentację wielu języków programowania i skryptów oraz bibliotek, a także różne oprogramowanie, takie jak Docker, Nginx, WordPress i ElasticSearch, aby wymienić tylko kilka.

Oto jak zainstalować, używać i dostosowywać Zeal w systemie Linux.

Instalowanie zapału

Zapał jest dostępny w repozytoriach oprogramowania wielu dystrybucji Linuksa, więc jeśli to możliwe, powinieneś zainstalować go za pomocą natywnego menedżera pakietów.

W systemach Ubuntu, Linux Mint i Debian:

W Arch Linux:

Na Gentoo:

W Fedorze:

Korzystanie z zapału

Możesz uruchomić Zeal z menu aplikacji / programu uruchamiającego lub z poziomu wiersza poleceń, wpisując polecenie zapał.

Zeal Initial Gui

Zapał nie zawiera domyślnie żadnej dokumentacji. Aby wyświetlić dostępne zestawy dokumentów, przejdź do „Narzędzia -> Zestawy dokumentów” i otwórz kartę „Dostępne”.

Zapał Dostępne dokumenty 1

Wybierz zestawy dokumentów, które chcesz zapisać, i kliknij „Pobierz”. Po pobraniu zestawy dokumentów są wyświetlane w lewym górnym panelu w hierarchicznej strukturze z możliwością nawigacji. W stosownych przypadkach w lewym dolnym panelu wyświetlane są skróty do elementów bieżącej strony dokumentu.

Zeal Docset Hierarchy

Możesz przeszukać wszystkie zestawy dokumentów, wpisując zapytanie lub określony zestaw dokumentów za pomocą składni docset: zapytanie. Na przykład, aby wyszukać funkcję re.match w Pythonie, należy wpisać python: re.match.

Note: ze składnią wyszukiwania złożonego (czyli docset: zapytanie), w części docset rozróżniana jest wielkość liter, a w części zapytania nie rozróżniana jest wielkość liter.

Zapał Przykładowe zapytanie

Dostosowywanie zapału

Czcionki

Możesz skonfigurować wygląd Zeal według własnych preferencji za pomocą czcionek i rozmiarów czcionek.

Aby to zrobić, przejdź do „Edycja -> Preferencje -> Treść”, a następnie wybierz domyślną rodzinę czcionek i określone czcionki dla każdej rodziny czcionek.

Wygląd preferencji zapału

Tryb ciemny

Zapał zapewnia również tryb ciemny (w „Edycji -> Preferencje -> Treść”), chociaż jest stosowany tylko do zawartości dokumentu, a nie do otaczającego interfejsu graficznego, jak widać na poniższym zrzucie ekranu.

Zapał Interfejs Ciemny 1

Zdefiniowany przez użytkownika CSS

Jeśli zamierzasz regularnie używać Zapału, warto poświęcić trochę czasu, aby dostosować go do własnego gustu. Możesz użyć niestandardowego arkusza stylów, aby uzyskać lepszą i dokładniejszą kontrolę wyglądu dokumentów.

Utwórz nowy plik CSS za pomocą edytora tekstu:

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

Wprowadź żądane zestawy reguł CSS, na przykład:

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

Przejdź do pliku „Edycja -> Preferencje -> Treść -> Niestandardowy CSS”, aby wybrać nowo utworzony plik CSS. Po zapisaniu ustawień zmiany będą widoczne natychmiast. Poniższy zrzut ekranu pokazuje Zeal po zastosowaniu powyższego CSS.

Zapał Wygląd niestandardowy 1

Wniosek

Zapał jest doskonałym narzędziem dla programistów i administratorów systemów, którzy często mają dostęp do dokumentacji. Ponieważ przechowuje dokumenty lokalnie, można zaoszczędzić czas i lepiej skoncentrować się na wykonywanej pracy. Ponadto, w przeciwieństwie do dokumentów internetowych, obsługuje arkusze stylów zdefiniowane przez użytkownika, co zapewnia dokładną kontrolę nad wyglądem dokumentu.

Czy ten artykuł jest przydatny?