GitBook je platforma, ktorá vám a vášmu tímu umožňuje vytvárať stránky s dokumentáciou a spolupracovať na nich. GitBook to robí pomocou konceptov riadenia verzií, ako je vetvenie a zlúčenie.

Keďže veľa členov tímu môže pracovať na jednej dokumentačnej lokalite, GitBook vám umožňuje vytvárať a spravovať samostatné koncepty. Môžete si tiež pozrieť rozdiely medzi vašou aktuálnou verziou a kópiou hlavnej dokumentácie.

K dispozícii máte niekoľko typov blokovania, ktoré môžete pridať na svoje stránky wiki. Patria sem nadpisy, odseky, obrázky, rady, tabuľky, bloky kódu, prílohy súborov a ďalšie.

Ako pridať bloky obsahu do GitBook

Môžete zobraziť zoznam dostupných blokov obsahu, ktoré môžete pridať na stránku. Môžete to urobiť kliknutím kdekoľvek na stránke a kliknutím na plus symbol, ktorý sa objaví. Môžete tiež priamo vyhľadať konkrétny blok obsahu.

Obsah môžete pridať pomocou Markdown. Ak ste ešte nepoužili Markdown, môžete sa dozvedieť viac o ako začať s Markdown. Môžete si tiež prečítať viac o prečo je Markdown taký populárny.

instagram viewer

Ako pridať odseky, zoznamy, citácie alebo bloky kódu

Ak chcete pridať zoznamy, odseky, úvodzovky, bloky kódu alebo iné bloky jednoduchého obsahu, otvorte rozbaľovaciu ponuku a vyberte si z dostupných typov.

  1. Na stránke vašej dokumentačnej lokality kliknite na plus v umiestnení, kam chcete pridať svoj obsah.
  2. V rozbaľovacom zozname sa môžete posúvať v zozname a zobraziť rôzne možnosti obsahu.
  3. Tu vyberte ľubovoľný jednoduchý typ obsahu, ako je odsek, blok kódu, nadpis alebo citát. GitBook automaticky zmení obsah tak, aby zodpovedal formátu, ktorý ste vybrali.

Ako pridať obrázky alebo prílohy súborov

Ak chcete pridať obrázky, vyberte pomocou rozbaľovacej ponuky snímky možnosť blokovania obsahu. Ak chcete pridať súbory, vyberte Vložiť súbory možnosť. Potom môžete použiť panel na pravej strane na spravovanie nahraných obrázkov a súborov.

  1. Otvorte stránku na svojej dokumentačnej lokalite. Klikni na plus otvorte rozbaľovaciu ponuku pre dostupné bloky obsahu.
  2. Vyberte Vložiť obrázky.
  3. V pravom paneli, ktorý sa zobrazí, sú tri karty. The Súbory karta vám umožňuje nahrať vlastný súbor obrázka. The URL karta vám umožňuje pripojiť sa k obrázku online. Môžete tiež otvoriť Unsplash tab. Tu môžete vybrať existujúce fotografie, ktoré nevyžadujú uvedenie zdroja.
  4. Po pridaní obrázka kliknite na tri bodky tlačidlo umiestnené v ľavom hornom rohu obrázka. Tým sa otvorí rozbaľovacia ponuka, v ktorej môžete obrázok zarovnať alebo ho odstrániť. K obrázku môžete pridať aj popis.
  5. Ak chcete vložiť súbory, umiestnite kurzor na ľubovoľné miesto na stránke dokumentácie. Klikni na plus otvorte rozbaľovaciu ponuku typov blokov obsahu. Tentoraz kliknite na vkladať súbory možnosť.
  6. Zobrazí sa podobný panel na pravej strane, ktorý vám umožní nahrať ľubovoľnú prílohu súboru namiesto obrázka. Kliknite na Prehľadávať súbory vyberte súbor uložený lokálne vo vašom počítači.
  7. Súbor sa zobrazí v zozname. Kliknite na súbor a GitBook vytvorí obsahový blok s prílohou súboru na stránke, ktorú máte otvorenú. Kliknutím na tento blok obsahu stiahnete prílohu súboru.

Ako pridať rady

Na svoju stránku môžete pridať aj rady. Ikonu pre rady môžete zmeniť tak, aby používala červenú pre nebezpečenstvo, oranžovú pre varovanie, modrú pre informácie alebo zelenú pre úspech.

  1. Ak chcete pridať nápovedu, kliknite na plus otvorte rozbaľovaciu ponuku pre dostupné bloky obsahu.
  2. Vyberte Nápoveda.
  3. To pridá na vašu stránku nápovedu. Štandardne je typ nápovedy „informácia“ a obsahuje modrú ikonu.
  4. Typ nápovedy môžete zmeniť kliknutím na ikonu. Toto bude prechádzať cez štyri rôzne typy tipov.

Ako pridať tabuľky

Tabuľky môžete pridať výberom položky tabuľky možnosť z rozbaľovacieho zoznamu. Keď máte tabuľku na stránke, môžete pridať nové riadky alebo stĺpce. Môžete tiež upraviť názvy a typy údajov stĺpcov a zmeniť údaje v tabuľke.

  1. Klikni na plus otvorte rozbaľovaciu ponuku pre dostupné bloky obsahu.
  2. Vyberte Tabuľka.
  3. Kliknite na hlavičku stĺpca v tabuľke. Tým sa otvorí nové menšie menu, kde môžete zmeniť názov vybraného stĺpca. Táto ponuka tiež umožňuje odstrániť alebo skryť vybraný stĺpec. Pre určité typy údajov stĺpca môžete zarovnať aj obsah vnútri stĺpca.
  4. V predvolenom nastavení je vybratý typ údajov pre stĺpce "Text". Kliknite na tlačidlo s T symbol na zmenu typu údajov. Môžete ho zmeniť na číslo, začiarkavacie políčko, rozbaľovaciu ponuku, prílohu súboru, hodnotenie alebo iné.
  5. Klikni na ikona šiestich bodiek v ľavom hornom rohu tabuľky. Tu môžete vložiť nové stĺpce a riadky alebo vymazať celú tabuľku. Môžete tiež skryť alebo zobraziť určité stĺpce alebo zmeniť iné vlastnosti tabuľky.

Ako pridať bloky odkazov na stránku

Bloky odkazov na stránku sú odkazy, ktoré zaberajú celý riadok na stránke. Keď pridáte odkaz, musíte odkazovať na stránku, ktorá sa otvorí, keď na ňu niekto klikne.

  1. Klikni na plus otvorte rozbaľovaciu ponuku pre dostupné bloky obsahu.
  2. Kliknite na Odkaz na stránku.
  3. Z novej rozbaľovacej ponuky vyberte stránku, na ktorú odkazujete.
  4. Odkaz na vašu stránku sa zobrazí v bloku na stránke.

Používanie GitBook na dokumentáciu

GitBook je dokumentačný nástroj, ktorý využíva koncepty riadenia verzií, ako je vetvenie a zlúčenie. To umožňuje viac ako jednému členovi tímu súčasne pracovať na dokumentácii. Pomáha tiež zvládať prípadné konflikty.

Na stránku môžete pridať všetky druhy blokov obsahu. Na preformátovanie obsahu môžete použiť nadpisy, odseky, bloky kódu alebo odrážky. Môžete zmeniť typ nápovedy, správu a typ nápovedy, ako aj prispôsobiť stĺpce tabuľky.

Karta Súbory vám umožňuje spravovať obrázky a prílohy súborov, ktoré odošlete na stránku. Odkazy na stránky vám umožňujú vytvárať veľké odkazy, ktoré používatelia ľahko nájdu.

Ak vytvárate dokumentáciu súvisiacu s jazykom Go, môžete použiť Godoc. Godoc vám umožňuje automaticky zdokumentovať váš Go kód.