Kā izveidot vienkāršu iekšējo Wiki, izmantojot Gitbook

GitBook ir platforma, kas ļauj izveidot dokumentācijas vietnes vai uzņēmuma wiki. Varat to izmantot, lai dokumentētu visu veidu lietas, sākot no koda līdz API un kā lietot programmatūras produktu.

GitBook izmanto līdzīgu procesu kā GitHub krātuvēs. Dokumentācijas galvenā kopija darbojas kā 'galvenā' kopija. Pēc tam varat izveidot 'melnrakstus', kas ir līdzīgi 'zariem'.

Šis process ļauj daudziem lietotājiem strādāt vienā dokumentācijas vietnē, vienlaikus apstrādājot vai novēršot konfliktus. Tas arī ļauj veikt izmaiņas dažādās filiālēs pirms to sapludināšanas pārskatīšanas procesā.

Kā sākt lietot GitBook

Jūs varat izvēlēties no vairākiem GitBook cenas plāniem. Cenas būs atkarīgas no tā, vai GitBook izmantojat atvērtā pirmkoda projektiem, personīgai lietošanai vai privātas komandas sadarbībai. GitBook var bez maksas izmantot, ja to izmantojat atvērtā pirmkoda projektiem.

GitBook atbalsta Markdown — populāra iezīmēšanas valoda ar daudzām priekšrocībām rakstīšanai vai dokumentēšanai tīmeklī.

GitBook integrējas arī ar GitHub, platforma koda mitināšanai, glabāšanai un rediģēšanai . Varat saistīt savu GitBook kontu tieši ar savu GitHub kontu, pierakstoties, izmantojot savus GitHub akreditācijas datus.

Reģistrējieties GitBook. Ja jums ir savs GitHub konts, varat noklikšķināt uz Reģistrējieties, izmantojot GitHub .
Kad esat pierakstījies, GitBook jūs novirzīs uz jaunu iekšējo wiki. Tas arī iepriekš aizpildīs jūsu wiki ar satura paraugu.

GitBook interfeisa pārskats

GitBook ir vairākas funkcijas, kas ļauj izveidot un veikt izmaiņas dokumentācijas vietnē.

kā izveidot saīsni iPhone

Augšējā panelī varat izveidot jaunus melnrakstus, skatīt izmaiņu vēsturi vai citas diskusijas vai pielikumus.
Kreisajā malā esošā sānjosla ļauj izveidot vairākas atstarpes. Varat izmantot atsevišķas vietas dažādiem projektiem, lai varētu atdalīt un sakārtot dokumentācijas apgabalus. Varat paplašināt vai aizvērt sānjoslu.
Kreisais panelis darbojas kā dokumentācijas vietnes izvēlne. Varat skatīt savas dokumentācijas vietnes lapas un izmantot to grupu un ligzdotu lapu izveidei. Varat arī pārvietoties pa vietni, izmantojot norādītās saites.
Apakšējā panelī ir pogas, kas ir ļoti svarīgas versiju kontroles procesam. Varat pievienot melnraksta nosaukumu, apvienot izmaiņas vai iesniegt izmaiņas pārskatīšanai.

Kā izveidot jaunu melnrakstu

Varat izveidot jaunu melnrakstu, izveidojot jaunu izmaiņu pieprasījumu un veicot tajā izmaiņas.

Augšējā panelī noklikšķiniet uz Izmaiņu pieprasījumi .
Jaunajā panelī, kas parādās labajā pusē, noklikšķiniet uz Melnraksts cilne. Tiks parādīti visi jūsu aktīvie melnraksti.
Šeit varat noklikšķināt uz esoša melnraksta, lai to atvērtu. Lai izveidotu jaunu melnrakstu, noklikšķiniet uz Jauns izmaiņu pieprasījums un pagaidiet, līdz tiek pabeigta lapas ielāde.
Apakšējā panelī noklikšķiniet uz Ievadiet tēmu . Tiks atvērts logs, kurā jaunajam melnrakstam varēsiet piešķirt nosaukumu. Piemēram, Jauna lapa — kā iestatīt kodu bāzi .

Kā izveidot lapas un grupas

Kad esat saņēmis melnrakstu, varat sākt veikt izmaiņas dokumentācijā. GitBook saglabā jūsu izmaiņas melnraksta iekšpusē, tāpēc tās neietekmē galveno kopiju. Varat izmantot kreiso sānjoslu, lai pievienotu lapas un lapu grupas.

Izveidojiet jaunu lapu, noklikšķinot uz Jauna lapa saiti sānjoslas apakšā un atlasot Jauna dokumenta lapa no nolaižamās izvēlnes. Varat arī virzīt kursoru zem esošas lapas un noklikšķināt uz zilās krāsas plus pogu.
Lai izveidotu jaunu lapu grupu, noklikšķiniet uz Jauna lapa un atlasiet Jauna grupa opciju no nolaižamās izvēlnes.
Lapu var pārdēvēt, noklikšķinot uz trim punktiem blakus lapai vai grupai un atlasot Pārdēvēt .
Sāciet pievienot saturu, lai aizpildītu savu jauno lapu. Varat pievienot vienkāršu saturu, piemēram, tekstu vai virsrakstus. GitBook ļauj pievienot arī citus satura blokus, piemēram, attēlus, failu pielikumus, tabulas, cilnes vai koda fragmentus. Ir arī iespēja pievienot citas integrācijas, piemēram, YouTube iegulšanas vai Google dokumentu saturu.
Noklikšķiniet uz Atšķirīgs skats pogu apakšējā panelī, lai skatītu atšķirības starp melnrakstu un oriģinālo pamatdokumentācijas kopiju.
Kad esat pabeidzis satura rakstīšanu, varat noklikšķināt uz Apvienot , Iesniegt un apvienot , vai Iesniegt pārskatīšanai .

Kā izveidot saiti uz dokumentācijas vietni

Koplietošanas saitei varat piekļūt no GitBook augšējā paneļa. Lai varētu skatīt saiti, jums ir jābūt ārpus melnraksta un jāskata galvenā dokumentācijas kopija.

Pēc noklusējuma jūsu dokumentācijas vietnes redzamība ir 'nesarakstā'. Tas nozīmē, ka dokumentācijas vietnei varat piekļūt, izmantojot privātu saiti, nevis meklētājprogrammas. Augšējā panelī noklikšķiniet uz Nerindots pogu.
Nolaižamajā izvēlnē atlasiet vēlamos redzamības iestatījumus. Ņemiet vērā, ka GitBook var bloķēt noteiktus redzamības iestatījumus, un jums, iespējams, būs jāveic jaunināšana, lai tiem piekļūtu.
Zem redzamības iestatījumu saraksta ir saite, kuru varat kopīgot ar citiem lietotājiem, kuri izmantos jūsu dokumentācijas vietni. Kopējiet šo saiti, lai kopīgotu to ar citiem.
Zem saites noklikšķiniet uz Saites un domēna iestatījumi . Šeit varat saistīt pielāgotu domēna nosaukumu vai modificēt URL daļu. Ja izmantojat pielāgotu domēnu, varat skatīt Gitbook dokumentācija par to, kā pareizi konfigurēt savu DNS.

Dokumentācijas izveide, izmantojot GitBook

GitBook ļauj kopīgi izveidot un strādāt ar dokumentācijas vietnēm vai uzņēmuma wiki. GitBook aizņemas no GitHub koncepcijas, piemēram, filiāles un apvienošanu, lai kontrolētu galveno kopiju un pārvaldītu visus konfliktus.

Varat izveidot jaunu melnrakstu, lai dokumentācijai pievienotu savas individuālās izmaiņas. Melnraksta ietvaros varat veikt izmaiņas saturā, kā arī pievienot jaunas lapas vai lapu grupas. Kad esat pabeidzis veikt izmaiņas, varat tās apvienot vai iesniegt pārskatīšanai.

Ja veidojat iekšējo dokumentāciju savam Java kodam, iespējams, vēlēsities izpētīt Javadoc. Javadoc ļauj automātiski dokumentēt savu Java kodu.