GitBook, pište dokumentaci k vašim projektům z Ubuntu

V příštím článku se podíváme na GitBook. Tohle je jeden cross-platform GUI aplikace, jehož hlavní funkcí je přinést pracovní postup GitBook na naši plochu v Ubuntu. Když se podíváte na jeho rozhraní, uvidíte, že je dobře promyšlený pro úpravy textu a práci s živým náhledem projektu.

GitBook byl vytvořen v polovině roku 2014. Zrodil se s cílem vytvořit Moderní a jednoduché řešení pro vytváření dokumentů, digitální psaní a publikování obsahu. Filozofie projektu musí být jednoduchá, aniž by došlo ke ztrátě elegance. Rozptylování a starosti tvůrců obsahu jsou eliminovány, takže mohou volně psát.

Stovky tisíc uživatelů používají GitBook k napsat dokumentaci (knihovna, API, nástroje atd.) nebo znalostní báze (například FAQ). Lidé také používají tento program k publikování technických knih, učebních materiálů a mnoha dalších věcí.

Obecné funkce GitBooku

Tohle je online platforma pro psaní a hostování dokumentace. Poskytuje otevřený zdrojový formát knih a řetězců nástrojů.

Tento program nám nabídne integrované ovládací prvky Git. Budeme také mít k dispozici panel obsahu, panel stromů souborů a tlačítka pro rychlé formátování, které usnadní strukturování našich dokumentů.

GitBook nám navíc nabízí možnost zobrazovat náš obsah jako web (přizpůsobitelné a rozšiřitelné) nebo jako ebook (PDF, ePub nebo Mobi).

GitBook.com je online platforma pro vytváření a hostování knih vytvořených ve formátu aplikace. Nabízí hostování, funkce spolupráce a snadno použitelný editor. Tento program nám umožňuje používat náš tým k vytváření místních knih, na GitHubu nebo na platformě k jejich hostování.

Aby mohli tento program začít používat, tvůrci dávají uživatelům možnost konzultovat pokyny pro instalaci v dokumentaci. Pokud to kterýkoli uživatel chce nebo potřebuje, může nahlédnout do zdrojového kódu této aplikace na stránce GitHub této aplikace.

Instalace GitBooku

Pokud si chcete stáhnout programový balíček, můžete si ho stáhnout ze svého Oficiální stránky. Tady můžeme stáhněte jej pomocí prohlížeče. Balíček můžeme získat také pomocí příkaz wget otevření terminálu (Ctrl + Alt + T) a zadání následujícího:

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

Jakmile je balíček stažen, můžeme jej nainstalovat spuštěním následujícího příkazu ve stejném terminálu:

dpkg -i linux-64-bit

Po dokončení instalace budete moci použít vyhledávací pole Ubuntu Dash a zadat gitbook. Na obrazovce se zobrazí ikona aplikace.

Když jsme se přihlásili, buď pomocí a Účet GitBook nebo náš účet na sociálních médiích, můžeme nyní vytvořit novou knihu. Můžeme to udělat kliknutím na možnost Nová kniha, která je k dispozici na obrazovce.

Nyní můžete začít napište svou vlastní knihu do editoru. Nezapomeňte v editoru vybrat úložiště, do kterého chceme nahrát změny.

Jak synchronizovat Gitbook s Github?

Na tomto programu je velmi zajímavé to, že nám nabízí možnost práce s GitHub. Četl jsem, že pro některé lidi to byl problém synchronizovat úložiště Github s platformou GitBook.

První věc, kterou musíme udělat, je vytvořte veřejné úložiště na Githubu. Budeme také potřebovat vytvořte knihu na webu Gitbook. Doporučuje se, i když si myslím, že není nutné, aby oba repozitáře měly stejný název.

Jakmile je kniha vytvořena, je důležité získat přístup k Book Setting tools and go to the Github section. Jakmile jste uvnitř, budete pokračovat zvolte integraci s úložištěm GitHub se kterou chcete synchronizovat. Jakmile bude úložiště vybráno, budeme celý proces nadále přijímat a ukládat.

Jakmile je tato operace provedena, pokud vše proběhlo dobře, měla by se objevit zelená zpráva, která indikuje, že integrace s Github funguje to.

Zkontrolovat, že vše funguje. Nyní zahájíme relaci s klientem GitBook, který jsme nainstalovali do našeho Ubuntu. Když to začne, můžeme provést změny, které považujeme za relevantní. Nyní je můžeme nahrát do nově vytvořeného Úložiště GitHub.