Jak przeglądać dokumentację kodu w trybie offline z zapałem

Jak przeglądać dokumentację kodu w trybie offline z zapałem.

Jeśli napisałeś jakikolwiek kod, prawdopodobnie zgadzasz się, że programowanie wymaga czytania dokumentacji, i to wielu. W wielu przypadkach czas poświęcony na czytanie dokumentacji i innego kodu przekracza rzeczywisty czas pisania kodu. A ponieważ dokumentacja ta jest najczęściej dostępna w Internecie, znaczna część czasu jest marnowana na szukanie informacji i czekanie, aż się załadują. Te niewielkie opóźnienia mogą być frustrujące, zwłaszcza przy wolniejszych połączeniach, i mogą szybko sumować się do minut lub godzin utraty produktywności. Poza tym dostęp do tych informacji wymaga stałego połączenia z Internetem, które nie zawsze jest dostępne,

Na szczęście możesz użyć Zeal, przeglądarki dokumentacji offline, do przechowywania dokumentacji języka programowania i oprogramowania na swoim komputerze oraz szybkiego i skutecznego dostępu do nich. Zeal korzysta z zestawów dokumentów (docsets) dostarczonych przez Dash. Zawierają dokumentację dla wielu języków i bibliotek programowania i skryptów, a także różne programy, takie jak Docker, Nginx, WordPress i ElasticSearch, by wymienić tylko kilka.

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

Instalowanie Zeala

Zeal 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 systemie Ubuntu, Linux Mint i Debian:

Sudo trafny zainstalować gorliwość

W Arch Linuxie:

Sudo pacman -S gorliwość

W Gentoo:

Sudo emerge app-doc/gorliwość

W Fedorze:

Sudo dnf zainstalować gorliwość

Używając zapału

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

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

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

Możesz przeszukiwać wszystkie zestawy dokumentów, wprowadzając zapytanie lub konkretny zestaw dokumentów ze składnią docset:query. Na przykład, aby wyszukać funkcję re.match Pythona, należy wpisać python:re.match.

Uwaga: ze składnią wyszukiwania złożonego (tj. docset:query) w części docset rozróżniana jest wielkość liter, aw części zapytania nie jest uwzględniana wielkość liter.

Dostosowywanie Zapału

Czcionki

Możesz skonfigurować wygląd Zeal według własnych upodobań 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.

Tryb ciemny

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

CSS zdefiniowany przez użytkownika

Jeśli zamierzasz regularnie używać Zeala, warto poświęcić trochę czasu na dostosowanie go do własnych upodobań. Możesz użyć niestandardowego arkusza stylów, aby uzyskać większą i dokładniejszą kontrolę nad wyglądem dokumentów.

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

krzepkość ~/.lokalny/udział/Gorliwość/niestandardowe CSS

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

kod {
styl graniczny: przerywana;
szerokość granicy: 1 piks;
kolor: czerwony;
}

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

Wniosek

Zeal to świetne narzędzie dla programistów i administratorów systemów, którzy często korzystają z dokumentacji. Ponieważ przechowuje dokumenty lokalnie, może zaoszczędzić czas i pozwala lepiej skupić się na wykonywanej pracy. Ponadto, w przeciwieństwie do dokumentów internetowych, obsługuje zdefiniowane przez użytkownika arkusze stylów, co zapewnia precyzyjną kontrolę nad wyglądem dokumentu.

Nigdy nie przegap

Otrzymuj aktualizacje naszych najnowszych samouczków.

Zapisz się na wszystkie newslettery.

Chcę otrzymywać newslettery pocztą elektroniczną. Nie udostępnimy Twoich danych i w każdej chwili możesz zrezygnować z subskrypcji.

Subskrybuj

Rejestrując się, wyrażasz zgodę na naszą Politykę prywatności, a użytkownicy europejscy zgadzają się na zasady przesyłania danych.