ГитБоок је платформа која омогућава вама и вашем тиму да креирате и сарађујете на сајтовима за документацију. ГитБоок то ради користећи концепте контроле верзија, као што су гранање и спајање.
Пошто многи чланови тима могу да раде на једној локацији за документацију, ГитБоок вам омогућава да креирате и управљате одвојеним нацртима. Такође можете видети разлике између тренутног нацрта и копије главне документације.
Неколико типова блокова је доступно за додавање на своје вики странице. Ово укључује наслове, пасусе, слике, савете, табеле, блокове кода, прилоге датотека и још много тога.
Како додати блокове садржаја у ГитБоок
Можете да видите листу доступних блокова садржаја за додавање на страницу. То можете учинити тако што ћете кликнути било где на страници и кликнути на плус симбол који се појављује. Такође можете директно тражити одређени блок садржаја.
Можете додати садржај користећи Маркдовн. Ако раније нисте користили Маркдовн, можете сазнати више о томе како започети са Маркдовн-ом. Такође можете прочитати више о зашто је Маркдовн толико популаран.
Како додати пасусе, листе, цитате или блокове кода
Да бисте додали листе, пасусе, цитате, блокове кода или друге једноставне блокове садржаја, отворите падајући мени и изаберите неки од доступних типова.
- На страници на вашем сајту за документацију кликните на плус дугме на месту где желите да додате свој садржај.
- Из падајућег менија можете да се крећете кроз листу да бисте видели различите опције садржаја.
- Одавде изаберите било који једноставан тип садржаја, као што је пасус, блок кода, наслов или цитат. ГитБоок ће аутоматски променити садржај тако да одговара формату који сте изабрали.
Како додати слике или прилоге датотека
Да бисте додали слике, користите падајући мени да бисте изабрали Слике опција блока садржаја. Да бисте додали датотеке, изаберите Инсерт Филес опција уместо тога. Затим можете користити десну таблу за управљање отпремљеним сликама и датотекама.
- Отворите страницу на вашем сајту за документацију. Кликните на плус дугме да бисте отворили падајући мени за доступне блокове садржаја.
- Изаберите Уметните слике.
- У десном панелу који се појављује, постоје три картице. Тхе Фајлови картица вам омогућава да отпремите сопствену датотеку слике. Тхе УРЛ картица вам омогућава да повежете слику на мрежи. Такође можете отворити Унспласх таб. Овде можете да изаберете постојеће фотографије које не захтевају приписивање.
- Када додате слику, кликните на три тачке дугме које се налази у горњем левом углу слике. Ово ће отворити падајући мени где можете да поравнате слику или да је избришете. Слици можете дати и натпис.
- Да бисте уметнули датотеке, поставите курсор било где на страницу на вашем сајту за документацију. Кликните на плус дугме за отварање падајућег менија за типове блокова садржаја. Овог пута кликните на убаците датотеке опција.
- Појавиће се сличан панел са десне стране, који вам омогућава да отпремите било који прилог датотеке уместо слике. Кликните на Прегледајте датотеке да бисте изабрали датотеку која се налази локално на вашем рачунару.
- Датотека ће се појавити на листи. Кликните на датотеку и ГитБоок ће креирати блок садржаја са прилогом датотеке на страници коју сте отворили. Кликом на овај блок садржаја преузима се прилог датотеке.
Како додати савете
Такође можете додати наговештаје на своју страницу. Можете да промените икону за савете да користите црвену за опасност, наранџасту за упозорење, плаву за информације или зелену за успех.
- Да бисте додали наговештај, кликните на плус дугме да бисте отворили падајући мени за доступне блокове садржаја.
- Изаберите Наговестити.
- Ово ће додати наговештај вашој страници. Подразумевано, тип наговештаја је „информације“ и садржи плаву икону.
- Тип наговештаја можете променити кликом на икону. Ово ће проћи кроз четири различита типа наговештаја.
Како додати табеле
Можете додати табеле тако што ћете изабрати сто опцију са падајуће листе. Када имате табелу на страници, можете додати нове редове или колоне. Такође можете да измените имена и типове података колона и промените податке унутар табеле.
- Кликните на плус дугме да бисте отворили падајући мени за доступне блокове садржаја.
- Изаберите Сто.
- Кликните на заглавље колоне у табели. Ово ће отворити нови мањи мени, где можете променити назив изабране колоне. Овај мени вам такође омогућава да избришете или сакријете изабрану колону. За одређене типове података колоне, такође можете поравнати садржај унутар колоне.
- Подразумевано, изабрани тип података за колоне је „Текст“. Кликните на дугме са Т симбол за промену типа података. Можете га променити у број, поље за потврду, падајући мени, прилог датотеке, оцену или више.
- Кликните на икона са шест тачака близу горњег левог угла табеле. Овде можете уметнути нове колоне и редове или избрисати целу табелу. Такође можете сакрити или приказати одређене колоне, или променити друга својства за табелу.
Како додати блокове веза на страницу
Блокови веза странице су везе које заузимају читав ред на страници. Када додате везу, морате да се повежете на страницу која ће се отворити када неко кликне на њу.
- Кликните на плус дугме да бисте отворили падајући мени за доступне блокове садржаја.
- Кликните на Линк странице.
- У новом падајућем менију изаберите страницу на коју повезујете.
- Веза ваше странице ће се појавити унутар блока на страници.
Коришћење ГитБоок-а за документацију
ГитБоок је документациони алат који користи концепте контроле верзија као што су гранање и спајање. Ово омогућава више од једног члана тима да истовремено ради на документацији. Такође помаже у управљању свим сукобима који се појаве.
Можете додати све врсте блокова садржаја на страницу. Можете да користите наслове, пасусе, блокове кода или тачке за набрајање да бисте поново форматирали свој садржај. Можете да промените тип наговештаја, поруку и тип иконе савета, као и да прилагодите колоне табеле.
Картица Датотеке вам омогућава да управљате сликама и прилозима датотека које отпремате на локацију. Везе страница вам омогућавају да креирате велике везе које корисници могу лако уочити.
Ако креирате документацију која се односи на Го језик, можете користити Годоц. Годоц вам омогућава да аутоматски документујете свој Го код.