A GitBook egy olyan platform, amely lehetővé teszi Önnek és csapatának dokumentációs webhelyek létrehozását és együttműködését. A GitBook ezt verziókezelési koncepciók, például elágazás és összevonás segítségével teszi.

Mivel sok csapattag dolgozhat egyetlen dokumentációs oldalon, a GitBook lehetővé teszi külön vázlatok létrehozását és kezelését. Megtekintheti a jelenlegi piszkozata és a fő dokumentáció másolata közötti különbségeket is.

Számos típusú blokk áll rendelkezésre, amelyeket hozzáadhat a wiki oldalaihoz. Ide tartoznak a címsorok, bekezdések, képek, tippek, táblázatok, kódblokkok, fájlmellékletek stb.

Tartalomblokkok hozzáadása a GitBookhoz

Megtekintheti az oldalhoz hozzáadható elérhető tartalomblokkok listáját. Ezt úgy teheti meg, hogy az oldal tetszőleges pontjára kattint, és rákattint a plusz szimbólum jelenik meg. Közvetlenül is kereshet egy adott tartalomblokkot.

Tartalmat a Markdown segítségével adhat hozzá. Ha még nem használta a Markdown szolgáltatást, többet megtudhat róla hogyan kezdjük el a Markdownt. Erről is olvashat bővebben miért olyan népszerű a Markdown.

instagram viewer

Bekezdések, listák, idézetek vagy kódblokkok hozzáadása

Listák, bekezdések, idézetek, kódblokkok vagy más egyszerű tartalomblokkok hozzáadásához nyissa meg a legördülő listát, és válasszon a rendelkezésre álló típusok közül.

  1. A dokumentációs webhely egyik oldalán kattintson a gombra plusz gombra azon a helyen, ahová a tartalmat hozzá szeretné adni.
  2. A legördülő menüből görgetheti a listát a különböző tartalombeállítások megtekintéséhez.
  3. Innen válasszon bármilyen egyszerű tartalomtípust, például bekezdést, kódblokkot, címsort vagy idézetet. A GitBook automatikusan módosítja a tartalmat, hogy megfeleljen az Ön által kiválasztott formátumnak.

Képek vagy fájlmellékletek hozzáadása

Képek hozzáadásához a legördülő menüből válassza ki a Képek tartalomblokk opció. Fájlok hozzáadásához válassza ki a Fájlok beszúrása lehetőség helyett. Ezután a jobb oldali panelen kezelheti feltöltött képeit és fájljait.

  1. Nyisson meg egy oldalt a dokumentációs webhelyén. Kattintson a plusz gombot az elérhető tartalomblokkok legördülő menüjének megnyitásához.
  2. Válassza ki Képek beszúrása.
  3. A megjelenő jobb oldali panelen három lap található. Az Fájlok fül lehetővé teszi saját képfájl feltöltését. Az URL fül lehetővé teszi, hogy egy képre online hivatkozzon. Ki is nyithatja a Unsplash lapon. Itt választhatja ki a meglévő fényképeket, amelyek nem igényelnek forrásmegjelölést.
  4. Miután hozzáadott egy képet, kattintson a három pont gombot a kép bal felső sarkában. Ezzel megnyílik egy legördülő menü, ahol igazíthatja vagy törölheti a képet. A képhez feliratot is adhat.
  5. Fájlok beszúrásához vigye a kurzort a dokumentációs webhely egy oldalára. Kattintson a plusz gombot a tartalomblokk típusok legördülő menüjének megnyitásához. Ezúttal kattintson a fájlok beszúrása választási lehetőség.
  6. Megjelenik egy hasonló jobb oldali panel, amely lehetővé teszi, hogy kép helyett bármilyen fájlmellékletet töltsön fel. Kattintson Fájlok böngészése a számítógépen helyileg tárolt fájl kiválasztásához.
  7. A fájl megjelenik a listán. Kattintson a fájlra, és a GitBook létrehoz egy tartalomblokkot a fájl mellékletével a megnyitott oldalon. Erre a tartalomblokkra kattintva letöltheti a mellékletet.

Tippek hozzáadása

Tippeket is hozzáadhat az oldalához. Módosíthatja a tippek ikonját úgy, hogy a pirosat a veszélyre, a narancsot a figyelmeztetésre, a kéket a tájékoztatásra, a zöldre pedig a sikerre vonatkozóan.

  1. Tipp hozzáadásához kattintson a gombra plusz gombot az elérhető tartalomblokkok legördülő menüjének megnyitásához.
  2. Válassza ki Célzás.
  3. Ez egy tippet ad az oldalához. Alapértelmezés szerint a tipp típusa "információ", és egy kék ikont tartalmaz.
  4. Az ikonra kattintva módosíthatja a tipp típusát. Ez végigfut a négy különböző tipptípuson.

Táblázatok hozzáadása

A táblázatok kiválasztásával adhat hozzá táblázatokat asztal opciót a legördülő listából. Miután a táblázat megvan az oldalon, új sorokat vagy oszlopokat vehet fel. Módosíthatja az oszlopok nevét és adattípusát, valamint módosíthatja a táblázaton belüli adatokat.

  1. Kattintson a plusz gombot az elérhető tartalomblokkok legördülő menüjének megnyitásához.
  2. Válassza ki asztal.
  3. Kattintson egy oszlop fejlécére a táblázatban. Ezzel megnyílik egy új, kisebb menü, ahol megváltoztathatja a kiválasztott oszlop nevét. Ez a menü lehetővé teszi a kiválasztott oszlop törlését vagy elrejtését is. Bizonyos oszlopadattípusok esetén a tartalmat az oszlopon belül is igazíthatja.
  4. Alapértelmezés szerint az oszlopokhoz kiválasztott adattípus "Szöveg". Kattintson a gombra a T szimbólum az adattípus megváltoztatásához. Módosíthatja számra, jelölőnégyzetre, legördülő menüre, fájlmellékletre, értékelésre vagy egyebekre.
  5. Kattintson a hat pont ikonra az asztal bal felső sarkához közel. Itt új oszlopokat és sorokat szúrhat be, vagy törölheti a teljes táblázatot. Ezenkívül elrejthet vagy megjeleníthet bizonyos oszlopokat, vagy módosíthatja a táblázat egyéb tulajdonságait.

Oldalhivatkozási blokkok hozzáadása

Az oldalhivatkozás blokkok olyan hivatkozások, amelyek az oldalon lévő teljes sort foglalják el. A hivatkozás hozzáadásakor hivatkoznia kell arra az oldalra, amely megnyílik, ha valaki rákattint.

  1. Kattintson a plusz gombot az elérhető tartalomblokkok legördülő menüjének megnyitásához.
  2. Kattintson Oldal Link.
  3. Az új legördülő menüből válassza ki azt az oldalt, amelyre hivatkozik.
  4. Az oldal hivatkozása az oldalon lévő blokkban fog megjelenni.

A GitBook használata a dokumentációhoz

A GitBook egy olyan dokumentációs eszköz, amely olyan verziókezelési koncepciókat használ, mint az elágazás és az összevonás. Ez lehetővé teszi, hogy a csapat egynél több tagja egyidejűleg dolgozzon a dokumentáción. Segít az esetleges konfliktusok kezelésében is.

Mindenféle tartalomblokkot hozzáadhat egy oldalhoz. A tartalom újraformázásához címsorokat, bekezdéseket, kódblokkokat vagy felsorolásjeleket használhat. Módosíthatja a tippek típusát, üzenetét és ikontípusát, valamint testreszabhatja a táblázat oszlopait.

A Fájlok lapon kezelheti a webhelyre feltöltött képeket és fájlmellékleteket. Az oldalhivatkozások segítségével nagyméretű linkeket hozhat létre, amelyeket a felhasználók könnyen észrevehetnek.

Ha a Go nyelvhez kapcsolódó dokumentációt készít, használhatja a Godoc-ot. A Godoc lehetővé teszi a Go kód automatikus dokumentálását.