GitBook, píšte dokumentáciu k svojim projektom z Ubuntu

V nasledujúcom článku sa pozrieme na GitBook. Toto je jeden multiplatformová aplikácia GUI, ktorej hlavnou funkciou je priniesť pracovný tok GitBook na našu pracovnú plochu v Ubuntu. Pri pohľade na jeho rozhranie uvidíte, že je dobre premyslený na úpravy textu a prácu so živým náhľadom projektu.

GitBook bol vytvorený v polovici roku 2014. Zrodil sa s cieľom vytvoriť Moderné a jednoduché riešenie na vytváranie dokumentov, digitálne písanie a publikovanie obsahu. Filozofia projektu musí byť jednoduchá bez straty elegancie. Rozptyľovanie a starosti tvorcov obsahu sú eliminované, takže môžu voľne písať.

Státisíce používateľov používajú GitBook na napísať dokumentáciu (knižnica, API, nástroje atď.) alebo znalostné bázy (napríklad často kladené otázky). Ľudia tiež používajú tento program na publikovanie technických kníh, učebných materiálov a mnohých ďalších vecí.

Všeobecné vlastnosti GitBooku

Toto je online platforma na písanie a hosťovanie dokumentácie. Poskytuje otvorený zdrojový formát kníh a reťazce nástrojov.

Tento program nám ponúkne zabudované ovládacie prvky Git. Ďalej budeme mať k dispozícii panel obsahu, panel stromov súborov a tlačidlá rýchleho formátovania, ktoré uľahčia štruktúrovanie našich dokumentov.

GitBook nám navyše ponúka možnosť zobraziť náš obsah ako webovú stránku (prispôsobiteľné a rozšíriteľné) alebo ako ebook (PDF, ePub alebo Mobi).

GitBook.com je online platforma na vytváranie a hosťovanie kníh vytvorených v aplikačnom formáte. Ponúka hosting, funkcie spolupráce a ľahko použiteľný editor. Tento program nám umožňuje používať náš tím na vytváranie miestnych kníh, na GitHub alebo na platforme k ich hosteniu.

Ak chcú tento program začať používať, jeho tvorcovia sprístupňujú používateľom možnosť konzultovať návod na inštaláciu v dokumentácii. Ak to ktorýkoľvek užívateľ chce alebo potrebuje, môže sa obrátiť na zdrojový kód tejto aplikácie na stránke GitHub tejto prihlášky.

Inštalácia GitBooku

Ak si chcete stiahnuť programový balík, môžete si ho stiahnuť zo svojho Oficiálne stránky. Tam môžeme stiahnite si ho pomocou prehliadača. Balíka sa môžeme zmocniť aj pomocou príkaz wget otvorením terminálu (Ctrl + Alt + T) a zadaním nasledujúceho príkazu:

wget http://downloads.editor.gitbook.com/download/linux-64-bit

Po stiahnutí balíka ho môžeme nainštalovať vykonaním nasledujúceho príkazu v rovnakom termináli:

dpkg -i linux-64-bit

Po dokončení inštalácie budete môcť použiť vyhľadávacie pole Ubuntu Dash a napísať gitbook. Na obrazovke sa zobrazí ikona aplikácie.

Keď sme sa prihlásili, buď pomocou a Účet GitBook alebo náš účet na sociálnych sieťach, môžeme teraz vytvoriť novú knihu. Môžeme to urobiť kliknutím na možnosť Nová kniha, ktorá je k dispozícii na obrazovke.

Teraz môžete začať napíšte svoju vlastnú knihu v editore. Nezabudnite v editore zvoliť úložisko, do ktorého chceme zmeny nahrať.

Ako synchronizovať Gitbook s Github?

Na tomto programe je veľmi zaujímavé to, že nám ponúka možnosť spolupráce s GitHubom. Čítal som, že pre niektorých ľudí to bol problém synchronizujte úložisko Github s platformou GitBook.

Prvá vec, ktorú budeme musieť urobiť, je vytvorte verejné úložisko na Githube. Budeme tiež potrebovať vytvorte knihu na webe Gitbook. Odporúča sa to, aj keď si myslím, že nie je nevyhnutné, aby mali oba úložiská rovnaký názov.

Akonáhle je kniha vytvorená, je dôležité mať prístup k Nástroje na nastavenie kníh a prejdite do sekcie Github. Keď sa dostanete dovnútra, budete pokračovať do zvoľte integráciu s úložiskom GitHub s ktorými chcete synchronizovať. Po výbere úložiska budeme celý proces naďalej prijímať a ukladať.

Ak je po vykonaní tejto operácie všetko v poriadku, mala by sa zobraziť zelená správa označujúca, že integrácia s Github funguje to.

Skontrolovať, či všetko funguje. Teraz začneme reláciu s klientom GitBook, ktorý sme nainštalovali do nášho Ubuntu. Na začiatku môžeme vykonať zmeny, ktoré považujeme za relevantné. Teraz ich môžeme nahrať do nášho novo vytvoreného Úložisko GitHub.