Hur man visar koddokumentation offline med iver

Om du har skrivit nÄgon kod, hÄller du nog med om att programmering innebÀr att du lÀser dokumentation, mycket av den. I mÄnga fall överstiger tiden för att lÀsa dokumentation och annan kod den faktiska tiden för att skriva koden. Och eftersom dokumentationen oftare Àn inte nÄs pÄ webben slösas en betydande del av tiden med att hitta informationen du letar efter och vÀntar pÄ att den ska laddas. Dessa smÄ förseningar kan vara frustrerande, sÀrskilt med lÄngsammare anslutningar och kan snabbt lÀgga till nÄgra minuter eller timmar förlorad produktivitet. Dessutom krÀvs en konstant Internet-anslutning, som inte alltid Àr tillgÀnglig för att fÄ tillgÄng till den informationen,

Lyckligtvis kan du anvÀnda Zeal, en offline-dokumentationswebblÀsare, för att lagra programmeringssprÄk och programvarudokumentation pÄ din dator och komma Ät den snabbt och effektivt. Zeal anvÀnder dokumentuppsÀttningar (docsets) som tillhandahÄlls av Rusa. De inkluderar dokumentation för mÄnga programmerings- och skriptsprÄk och bibliotek, sÄvÀl som olika programvara som Docker, Nginx, WordPress och ElasticSearch, för att nÀmna nÄgra.

SÄ hÀr installerar, anvÀnder och anpassar Zeal pÄ Linux.

Installera iver

Zeal Àr tillgÀngligt i mjukvarulager i mÄnga Linux-distributioner, sÄ du bör installera den med din ursprungliga pakethanterare om möjligt.

PĂ„ Ubuntu, Linux Mint och Debian:

PĂ„ Arch Linux:

PĂ„ Gentoo:

PĂ„ Fedora:

AnvÀnda iver

Du kan starta Zeal frÄn din applikationsmeny / startapparat eller frÄn en kommandoradsterminal genom att skriva iver.

Zeal Initial Gui

Zeal inkluderar inte nÄgon dokumentation som standard. För att visa tillgÀngliga dokumentuppsÀttningar, gÄ till "Verktyg -> DokumentuppsÀttningar" och öppna fliken "TillgÀnglig".

Zeal tillgÀngliga dokument 1

VĂ€lj de dokumentuppsĂ€ttningar du vill lagra och klicka pĂ„ ”Ladda ner.” NĂ€r de har hĂ€mtats visas dokumentuppsĂ€ttningar i det övre vĂ€nstra fönstret i en navigerbar hierarkisk struktur. NĂ€r det Ă€r tillĂ€mpligt visar den nedre vĂ€nstra rutan genvĂ€gar till elementen pĂ„ den aktuella dokumentsidan.

Zeal Docset Hierarchy

Du kan söka i alla dokumentuppsÀttningar genom att ange en frÄga eller en specifik docset med syntaxen docset: frÄga. För att till exempel söka efter Pythons re.match-funktion skulle du ange python: re.match.

Note: med den sammansatta söksyntaxen (det vill sÀga docset: frÄga), docset-delen Àr skiftlÀgeskÀnslig och frÄgestÀllningen Àr okÀnslig för versaler.

Zeal ExempelfrÄga

Anpassa iver

typsnitt

Du kan konfigurera Zeals utseende efter din smak med teckensnitt och teckenstorlekar.

För att göra det, gÄ till "Redigera -> InstÀllningar -> InnehÄll" och vÀlj sedan en standardtypfamilj och specifika teckensnitt för varje teckensnittsfamilj.

Zeal-preferenser Utseende

Mörkt lÀge

Zeal ger ocksÄ ett mörkt lÀge (i "Redigera -> InstÀllningar -> InnehÄll"), Àven om det endast tillÀmpas pÄ dokumentinnehÄllet och inte pÄ det omgivande grafiska grÀnssnittet, som du kan se i följande skÀrmdump.

Zeal Interface Dark 1

AnvÀndardefinierad CSS

Om du kommer att anvÀnda Zeal regelbundet, Àr det vÀrt att Àgna lite tid Ät att justera det efter din egen smak. Du kan anvÀnda ett anpassat formatmall för större och finare kontroll över utseendet pÄ dokument.

Skapa en ny CSS-fil med din textredigerare:

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

Ange önskade CSS-regeluppsÀttningar, till exempel:

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

GÄ till filen "Redigera -> InstÀllningar -> InnehÄll -> Anpassad CSS" för att vÀlja den nyligen skapade CSS-filen. NÀr du har sparat dina instÀllningar kommer Àndringarna att visas omedelbart. Följande skÀrmdump visar Zeal efter tillÀmpning av ovanstÄende CSS.

Iver Anpassad Utseende 1

Slutsats

Zeal Àr ett bra verktyg för programmerare och systemadministratörer som ofta har tillgÄng till dokumentation. Eftersom det lagrar dokument lokalt kan det spara tid och lÄta dig bÀttre fokusera pÄ det aktuella arbetet. Till skillnad frÄn webbdokument stöder det dessutom anvÀndardefinierade formatmallar för fin kontroll över dokumentets utseende.

Är den hĂ€r artikeln anvĂ€ndbar?

Hur man visar koddokumentation offline med iver
4.7 (94.55%) 11 Votes