GitBook je platforma, která vám a vašemu týmu umožňuje vytvářet dokumentační weby a spolupracovat na nich. GitBook to dělá pomocí konceptů správy verzí, jako je větvení a slučování.

Protože mnoho členů týmu může pracovat na jednom dokumentačním webu, GitBook vám umožňuje vytvářet a spravovat samostatné koncepty. Můžete si také prohlédnout rozdíly mezi vaší aktuální pracovní verzí a kopií hlavní dokumentace.

K dispozici je několik typů blokování, které můžete přidat na své stránky wiki. To zahrnuje nadpisy, odstavce, obrázky, rady, tabulky, bloky kódu, přílohy souborů a další.

Jak přidat bloky obsahu do GitBook

Můžete zobrazit seznam dostupných bloků obsahu, které lze přidat na stránku. Můžete to udělat kliknutím kamkoli na stránku a kliknutím na Plus symbol, který se objeví. Můžete také přímo vyhledat konkrétní blok obsahu.

Obsah můžete přidat pomocí Markdown. Pokud jste Markdown dosud nepoužívali, můžete se o něm dozvědět více jak začít s Markdown. Můžete si také přečíst více o proč je Markdown tak populární.

Jak přidat odstavce, seznamy, uvozovky nebo bloky kódu

Chcete-li přidat seznamy, odstavce, uvozovky, bloky kódu nebo jiné bloky jednoduchého obsahu, otevřete rozevírací seznam a vyberte z dostupných typů.

  1. Na stránce vašeho webu s dokumentací klikněte na Plus v umístění, kam chcete přidat svůj obsah.
  2. V rozevíracím seznamu můžete procházet seznam a zobrazit různé možnosti obsahu.
  3. Odtud vyberte libovolný jednoduchý typ obsahu, jako je odstavec, blok kódu, nadpis nebo citace. GitBook automaticky změní obsah tak, aby odpovídal formátu, který jste vybrali.

Jak přidat obrázky nebo přílohy souborů

Chcete-li přidat obrázky, vyberte pomocí rozevíracího seznamu snímky možnost blokování obsahu. Chcete-li přidat soubory, vyberte Vložit soubory místo toho. Poté můžete použít pravý panel ke správě nahraných obrázků a souborů.

  1. Otevřete stránku na svém webu s dokumentací. Klikněte na Plus otevřete rozevírací seznam dostupných bloků obsahu.
  2. Vybrat Vložit obrázky.
  3. V pravém panelu, který se zobrazí, jsou tři karty. The Soubory karta umožňuje nahrát vlastní soubor obrázku. The URL karta umožňuje online odkaz na obrázek. Můžete také otevřít Unsplash tab. Zde můžete vybrat existující fotografie, které nevyžadují uvedení zdroje.
  4. Po přidání obrázku klikněte na tři tečky tlačítko umístěné v levém horním rohu obrázku. Tím se otevře rozbalovací nabídka, kde můžete obrázek zarovnat nebo jej odstranit. K obrázku můžete také přidat popisek.
  5. Chcete-li vložit soubory, umístěte kurzor kamkoli na stránku webu s dokumentací. Klikněte na Plus otevřete rozevírací seznam typů bloků obsahu. Tentokrát klikněte na vkládat soubory volba.
  6. Objeví se podobný panel na pravé straně, který vám umožní nahrát libovolnou souborovou přílohu místo obrázku. Klikněte na Procházet soubory vyberte soubor uložený lokálně ve vašem počítači.
  7. Soubor se objeví v seznamu. Klikněte na soubor a GitBook vytvoří blok obsahu s přílohou souboru na stránce, kterou máte otevřenou. Kliknutím na tento blok obsahu stáhnete přílohu.

Jak přidat rady

Na stránku můžete také přidat rady. Ikonu pro nápovědu můžete změnit tak, aby používala červenou pro nebezpečí, oranžovou pro varování, modrou pro informace nebo zelenou pro úspěch.

  1. Chcete-li přidat nápovědu, klikněte na Plus otevřete rozevírací seznam dostupných bloků obsahu.
  2. Vybrat Náznak.
  3. Tím přidáte na stránku nápovědu. Ve výchozím nastavení je typ nápovědy „informace“ a obsahuje modrou ikonu.
  4. Typ nápovědy můžete změnit kliknutím na ikonu. Tím projdete čtyři různé typy nápověd.

Jak přidat tabulky

Tabulky můžete přidat výběrem stůl možnost z rozevíracího seznamu. Jakmile budete mít tabulku na stránce, můžete přidat nové řádky nebo sloupce. Můžete také upravit názvy a datové typy sloupců a změnit data v tabulce.

  1. Klikněte na Plus otevřete rozevírací seznam dostupných bloků obsahu.
  2. Vybrat Stůl.
  3. Klikněte na záhlaví sloupce v tabulce. Tím se otevře nové menší menu, kde můžete změnit název vybraného sloupce. Tato nabídka také umožňuje smazat nebo skrýt vybraný sloupec. U určitých typů dat sloupců můžete také zarovnat obsah uvnitř sloupce.
  4. Ve výchozím nastavení je vybraný datový typ pro sloupce "Text". Klikněte na tlačítko s T symbol pro změnu datového typu. Můžete jej změnit na číslo, zaškrtávací políčko, rozevírací seznam, přílohu souboru, hodnocení nebo další.
  5. Klikněte na ikona šesti teček poblíž levého horního rohu tabulky. Zde můžete vkládat nové sloupce a řádky nebo smazat celou tabulku. Můžete také skrýt nebo zobrazit určité sloupce nebo změnit jiné vlastnosti tabulky.

Jak přidat bloky odkazů na stránku

Bloky odkazů stránky jsou odkazy, které zabírají celý řádek na stránce. Když přidáte odkaz, musíte odkazovat na stránku, která se otevře, když na ni někdo klikne.

  1. Klikněte na Plus otevřete rozevírací seznam dostupných bloků obsahu.
  2. Klikněte na Odkaz na stránku.
  3. Z nové rozevírací nabídky vyberte stránku, na kterou odkazujete.
  4. Odkaz na vaši stránku se zobrazí uvnitř bloku na stránce.

Použití GitBook pro dokumentaci

GitBook je dokumentační nástroj, který využívá koncepty správy verzí, jako je větvení a slučování. To umožňuje více než jednomu členovi týmu současně pracovat na dokumentaci. Pomáhá také zvládat případné konflikty, které nastanou.

Na stránku můžete přidat všechny druhy bloků obsahu. K přeformátování obsahu můžete použít nadpisy, odstavce, bloky kódu nebo odrážky. Můžete změnit typ nápovědy, zprávu a typ ikony a také přizpůsobit sloupce tabulky.

Karta Soubory vám umožňuje spravovat obrázky a přílohy souborů, které nahrajete na web. Odkazy na stránky umožňují vytvářet velké odkazy, které uživatelé snadno zjistí.

Pokud vytváříte dokumentaci související s jazykem Go, můžete použít Godoc. Godoc vám umožňuje automaticky zdokumentovat váš Go kód.