TechLife devBlog

Zeal - dokumentacja pod ręką

Internet 31st Jul 2015

Zeal to inspirowana swoim Mac-owym płatnym odpowiednikiem (Dash) zgrabna przeglądarka dokumentacji dostępna na platformach Linux i Windows. Co ciekawe autorzy obu projektów dogadali się (Zeal reklamuje Dasha) dzięki czemu Zeal korzysta z dokumentacji przygotowanej dla Dash-a.

zeal

Pełną listę dostępnych dokumentacji znajdziecie pod adresem kapeli.com/dash#docsets. Obecnie jest ich ponad 150 i bardzo łatwo można dorzucić samemu kolejne lub podłączyć się do zewnętrznych dostawców.

Kluczowa w Zeal jest jednak integracja z większością znanych edytorów/IDE dzięki czemu dokumentację mamy zawsze pod ręką (zwłaszcza pracując offline), w miejscu gdzie jest nam najbardziej potrzebna.

pluginy

W przypadku Sublime'a instalacja jest banalna, wystarczy odnaleźć odpowiedni plugin i gotowe.

sublime

Po pierwszym uruchomieniu, należy wejść do opcji, przejść na zakładkę docsets i tam wybrać interesujące nas dokumentacje. Po ich pobraniu można już zabrać się za przeglądanie a Zeal będzie na bieżąco śledził ich aktualność.

django

Kiedy chcemy znaleźć dokumentację do interesującej nas komendy z poziomu edytora wystarczy ją zaznaczyć i wcisnąć odpowiedni dla edytora skrót klawiszowy (zazwyczaj F1).

wyszukiwanie w edytorze

Spowoduje to otwarcie Zeal-a dokładnie na szukanej komendzie.

wynik wyszukiwania

Możliwe jest również wyszukiwanie bezpośrednio w odpowiedniej dokumentacji. W tym celu używamy drugiego skrótu (Shift + F1 w przypadku Sublime'a) i wpisujemy odpowiednią formułkę korzystając ze składni kategoria:szukany_obiekt

wyszukiwanie w JavaScripcie

Wyniki zostaną ograniczone do podanej kategorii.

wyniki wyszukiwania w kategorii JavaScript

Pozostało zainstalować i używać, z pewnością przyśpieszy to naszą pracę i zastąpi ciągłe googlowanie. Użytkownikom Archa polecam instalację pakietu zeal-git dostępnego w AUR.

Strona projektu - zealdocs.org



Komentarze