Hogyan készítsünk egyszerű belső Wikit a Gitbook segítségével

Hogyan készítsünk egyszerű belső Wikit a Gitbook segítségével

A GitBook egy olyan platform, amely lehetővé teszi dokumentációs oldalak vagy vállalati wikik létrehozását. Használhatja mindenféle dolog dokumentálására, a kódtól az API-kig és a szoftvertermékek használatáig.





A GitBook a GitHub adattáraihoz hasonló folyamatot használ. A dokumentáció fő példánya „törzs” példányként működik. Ezután létrehozhat 'piszkozatokat', amelyek hasonlóak az 'ágakhoz'.



Ez a folyamat lehetővé teszi sok felhasználó számára, hogy egyetlen dokumentációs oldalon dolgozzon, miközben kezeli vagy megelőzi az ütközéseket. Lehetővé teszi azt is, hogy a különböző ágakból származó módosítások felülvizsgálati folyamaton menjenek keresztül, mielőtt összevonja őket.





Hogyan kezdjük el a GitBook használatát

Több közül választhatsz GitBook árazás terveket. Az ár attól függ, hogy a GitBookot nyílt forráskódú projektekhez, személyes használatra vagy privát csapatmunka céljára használja. A GitBook ingyenesen használható, ha nyílt forráskódú projektekhez használja.

GitBook támogatja Markdown, egy népszerű jelölőnyelv számos előnnyel az interneten való íráshoz vagy dokumentáláshoz.



miért veszíti el a számítógépem az internetkapcsolatot?

A GitBook is integrálható GitHub, a kód tárolására, tárolására és szerkesztésére szolgáló platform . GitBook-fiókját közvetlenül összekapcsolhatja GitHub-fiókjával, ha bejelentkezik GitHub hitelesítő adataival.

  1. Regisztráljon a GitBook-ra. Ha van saját GitHub-fiókja, kattintson a gombra Regisztráljon a GitHub segítségével .
  2. Miután bejelentkezett, a GitBook átirányít egy új belső wikire. Előzetesen feltölti a wikijét néhány mintatartalommal.

A GitBook felület áttekintése

A GitBook számos funkcióval rendelkezik, amelyek lehetővé teszik a dokumentációs webhely létrehozását és módosítását.



hogyan kell helyreállítani az iPhone 6 -ot helyreállítási módban
  1. A felső panelen új piszkozatokat hozhat létre, megtekintheti a változástörténetet, vagy megtekinthet bármilyen más megbeszélést vagy mellékletet.
  2. A bal szélső oldalsáv lehetővé teszi több tér létrehozását. Külön tereket használhat a különböző projektekhez, így elkülönítheti és rendszerezheti a dokumentációs területeket. Kibonthatja vagy bezárhatja az oldalsávot.
  3. A bal oldali panel a dokumentációs oldal menüjeként működik. Megtekintheti az oldalakat a dokumentációs webhelyen belül, és felhasználhatja csoportok és beágyazott oldalak létrehozására. Az oldalon található hivatkozások segítségével is navigálhat.
  4. Az alsó panelen olyan gombok találhatók, amelyek létfontosságúak a verziókezelési folyamathoz. Adhat nevet a piszkozatnak, egyesítheti a módosításokat, vagy elküldheti a módosítást felülvizsgálatra.

Hogyan készítsünk új piszkozatot

Létrehozhat új piszkozatot egy új módosítási kérelem létrehozásával, és módosításokkal.

  1. A felső panelen kattintson a gombra Módosítási kérések .
  2. A jobb oldalon megjelenő új panelen kattintson a Piszkozat lapon. Ez megjeleníti az összes aktív piszkozatot.
  3. Innen egy meglévő piszkozatra kattintva megnyithatja azt. Új piszkozat létrehozásához kattintson a gombra Új változtatási kérelem , és várja meg, amíg az oldal betöltődik.
  4. Az alsó panelen kattintson a gombra Írjon be egy tárgyat . Ekkor megnyílik egy ablak, ahol nevet adhat az új piszkozatnak. Például, Új oldal – A kódbázis beállítása .

Oldalak és csoportok létrehozása

Amint megvan a tervezet, elkezdheti módosítani a dokumentációt. A GitBook a változtatásokat a piszkozaton belül tárolja, így azok nem érintik a főpéldányt. A bal oldali oldalsáv segítségével oldalakat és oldalcsoportokat adhat hozzá.



  1. Hozzon létre egy új oldalt a gombra kattintva Új oldal linket az oldalsáv alján, és válassza ki Új dokumentum oldal a legördülő menüből. Alternatív megoldásként vigye az egérmutatót egy meglévő oldal alá, és kattintson a kékre plusz gomb.
  2. Új oldalcsoport létrehozásához kattintson a gombra Új oldal , és válassza ki a lehetőséget Új csoport opciót a legördülő menüből.
  3. Átnevezheti az oldalt az oldal vagy csoport melletti három pontra kattintva, majd kiválasztva Átnevezés .
  4. Kezdje el a tartalom hozzáadását az új oldal feltöltéséhez. Hozzáadhat egyszerű tartalmat, például szöveget vagy címsorokat. A GitBook lehetővé teszi más tartalomblokkok, például képek, fájlmellékletek, táblázatok, lapok vagy kódrészletek hozzáadását is. Lehetőség van további integrációk, például YouTube beágyazások vagy Google Dokumentumok-tartalom hozzáadására is.
  5. Kattintson a Diff nézet gombot az alsó panelen, hogy megtekinthesse a vázlat és az eredeti fődokumentáció másolata közötti különbségeket.
  6. Ha befejezte a tartalom megírását, kattintson a gombra Összeolvad , Küldje el és egyesítse , vagy Küldje el felülvizsgálatra .

A megosztási linket a GitBook felső paneléről érheti el. A hivatkozás megtekintéséhez ki kell lépnie a piszkozatból, és meg kell tekintenie a fő dokumentáció másolatát.

  1. Alapértelmezés szerint a dokumentációs webhely láthatósága „nem listázott”. Ez azt jelenti, hogy a dokumentációs oldalt privát hivatkozással érheti el, nem keresőmotorokon keresztül. A felső panelen kattintson a Nem listázott gomb.
  2. Válassza ki a kívánt láthatósági beállításokat a legördülő menüből. Vegye figyelembe, hogy a GitBook zárolhat bizonyos láthatósági beállításokat, és előfordulhat, hogy frissítenie kell ezek eléréséhez.
  3. A láthatósági beállítások listája alatt található egy hivatkozás, amelyet megoszthat más felhasználókkal, akik használni fogják az Ön dokumentációs webhelyét. Másolja ki ezt a linket, ha meg szeretné osztani másokkal.
  4. A link alatt kattintson a gombra Link- és domainbeállítások . Itt kapcsolhat össze egyéni domain nevet, vagy módosíthatja az URL egy részét. Ha egyéni domaint használ, megtekintheti Gitbook dokumentációja hogyan kell helyesen konfigurálni a DNS-t.

Dokumentáció készítése GitBook segítségével

A GitBook lehetővé teszi, hogy közösen hozzon létre dokumentációs oldalakat vagy vállalati wikiket, és dolgozzon azokon. A GitBook olyan koncepciókat kölcsönöz a GitHubtól, mint az elágazások és az összevonás, hogy vezérelje a mesterpéldányt és kezelje az esetleges konfliktusokat.

Létrehozhat egy új piszkozatot, hogy saját egyéni változtatásokat adjon hozzá a dokumentációhoz. A piszkozaton belül módosíthatja a tartalmat, valamint új oldalakat vagy oldalcsoportokat adhat hozzá. Miután végzett a módosításokkal, egyesítheti őket, vagy elküldheti őket felülvizsgálatra.

Ha belső dokumentációt készít a Java-kódhoz, érdemes lehet felfedezni a Javadoc-ot. A Javadoc lehetővé teszi a Java kód automatikus dokumentálását.