Jak vytvořit jednoduchou interní Wiki pomocí Gitbooku

Jak vytvořit jednoduchou interní Wiki pomocí Gitbooku

GitBook je platforma, která vám umožňuje vytvářet dokumentační stránky nebo firemní wiki. Můžete jej použít k dokumentaci všech druhů věcí, od kódu po API a jak používat softwarový produkt.





GitBook používá podobný proces jako úložiště GitHub. Hlavní kopie dokumentace funguje jako „hlavní“ kopie. Poté můžete vytvořit 'návrhy', které jsou podobné 'větvím'.



Tento proces umožňuje mnoha uživatelům pracovat na jediném dokumentačním webu a zároveň řešit konflikty nebo jim předcházet. Umožňuje také změny z různých větví projít procesem kontroly, než je sloučíte.





Jak začít používat GitBook

Můžete si vybrat z několika Ceny GitBook plány. Cena bude záviset na tom, zda GitBook používáte pro open source projekty, osobní použití nebo soukromou týmovou spolupráci. GitBook je zdarma k použití, pokud jej používáte pro open source projekty.

GitBook podporuje Markdown, oblíbený značkovací jazyk s mnoha výhodami pro psaní nebo dokumentaci na webu.



GitBook se také integruje s GitHub, platforma pro hostování, ukládání a úpravy kódu . Svůj účet GitBook můžete propojit přímo se svým účtem GitHub přihlášením pomocí svých přihlašovacích údajů GitHub.

  1. Zaregistrujte se na GitBook. Pokud máte svůj vlastní účet GitHub, můžete kliknout na Zaregistrujte se na GitHubu .
  2. Jakmile se přihlásíte, GitBook vás přesměruje na novou interní wiki. Také to předvyplní vaši wiki nějakým ukázkovým obsahem.

Přehled rozhraní GitBook

GitBook má několik funkcí, které vám umožňují vytvářet a měnit váš dokumentační web.



jaké jsou věci na zadní straně telefonů lidí
  1. Horní panel umožňuje vytvářet nové koncepty, prohlížet historii změn nebo prohlížet jakékoli další diskuze či přílohy.
  2. Postranní panel zcela vlevo umožňuje vytvořit více mezer. Pro různé projekty můžete použít oddělené prostory, abyste mohli oddělit a uspořádat oblasti dokumentace. Postranní panel můžete rozbalit nebo zavřít.
  3. Levý panel funguje jako nabídka pro web s dokumentací. Stránky s dokumentací můžete zobrazit a použít k vytváření skupin a vnořených stránek. Stránky můžete také procházet pomocí uvedených odkazů.
  4. Spodní panel obsahuje tlačítka, která jsou životně důležitá pro proces řízení verzí. Ke své pracovní verzi můžete přidat název, sloučit změnu nebo odeslat změnu ke kontrole.

Jak vytvořit nový koncept

Nový koncept můžete vytvořit vytvořením nového požadavku na změnu a provedením změn v něm.

  1. V horním panelu klikněte na Žádosti o změnu .
  2. Na novém panelu, který se objeví na pravé straně, klikněte na Návrh tab. Zobrazí se vám všechny vaše aktivní koncepty.
  3. Odtud můžete kliknout na existující koncept a otevřít jej. Chcete-li vytvořit nový koncept, klikněte na Nový požadavek na změnu a počkejte, až se stránka načte.
  4. Ve spodním panelu klikněte na Zadejte předmět . Otevře se okno, ve kterém můžete nový koncept pojmenovat. Například, Nová stránka - Jak nastavit Codebase .

Jak vytvářet stránky a skupiny

Jakmile budete mít koncept, můžete začít provádět změny v dokumentaci. GitBook ukládá vaše změny do konceptu, takže neovlivňují hlavní kopii. Pomocí levého postranního panelu můžete přidat stránky a skupiny stránek.



  1. Vytvořte novou stránku kliknutím na Nová stránka odkaz v dolní části postranního panelu a výběr Nová stránka dokumentu z rozbalovací nabídky. Případně můžete umístit kurzor myši pod existující stránku a kliknout na modrou Plus knoflík.
  2. Chcete-li vytvořit novou skupinu stránek, klikněte na Nová stránka a vyberte Nová skupina možnost z rozbalovací nabídky.
  3. Stránku můžete přejmenovat kliknutím na tři tečky vedle stránky nebo skupiny a výběrem Přejmenovat .
  4. Začněte přidávat obsah, aby se nová stránka naplnila. Můžete přidat jednoduchý obsah, jako je text nebo nadpisy. GitBook také umožňuje přidávat další bloky obsahu, jako jsou obrázky, přílohy souborů, tabulky, karty nebo úryvky kódu. K dispozici je také možnost přidat další integrace, jako jsou vložení YouTube nebo obsah Dokumentů Google.
  5. Klikněte na Rozdílný pohled tlačítko ve spodním panelu pro zobrazení rozdílů mezi vaším konceptem a původní kopií hlavní dokumentace.
  6. Jakmile dokončíte psaní obsahu, můžete kliknout na Spojit , Odeslat a sloučit nebo Odeslat ke kontrole .

K odkazu na sdílení se dostanete z horního panelu GitBook. Abyste mohli odkaz zobrazit, musíte být mimo koncept a prohlížet si kopii hlavní dokumentace.

  1. Ve výchozím nastavení je viditelnost vašeho webu s dokumentací „neuvedena“. To znamená, že k webu s dokumentací můžete přistupovat pomocí soukromého odkazu, nikoli prostřednictvím vyhledávačů. V horním panelu klikněte na Neuvedeno knoflík.
  2. Z rozbalovací nabídky vyberte požadované nastavení viditelnosti. Pamatujte, že GitBook může uzamknout určitá nastavení viditelnosti a pro přístup k nim možná budete muset upgradovat.
  3. Pod seznamem nastavení viditelnosti je odkaz, který můžete sdílet s ostatními uživateli, kteří budou používat váš web s dokumentací. Zkopírujte tento odkaz a sdílejte jej s ostatními.
  4. Pod odkazem klikněte na Nastavení odkazu a domény . Zde můžete propojit vlastní název domény nebo upravit část adresy URL. Pokud používáte vlastní doménu, můžete zobrazit Dokumentace Gitbook jak správně nakonfigurovat DNS.

Vytváření dokumentace pomocí GitBook

GitBook vám umožňuje společně vytvářet a pracovat na dokumentačních webech nebo firemních wiki. GitBook si vypůjčuje koncepty z GitHubu, jako jsou větve a slučování, aby bylo možné ovládat hlavní kopii a zvládat případné konflikty.

Můžete vytvořit nový koncept a přidat do dokumentace své vlastní změny. V pracovní verzi můžete provádět změny obsahu a také přidávat nové stránky nebo skupiny stránek. Jakmile provedete změny, můžete je sloučit nebo odeslat ke kontrole.

Pokud vytváříte interní dokumentaci pro svůj kód Java, možná budete chtít prozkoumat Javadoc. Javadoc vám umožňuje automaticky dokumentovat váš Java kód.