GitBook е платформа, която позволява на вас и вашия екип да създавате и да си сътрудничите в сайтове за документация. GitBook прави това, като използва концепции за контрол на версиите, като разклоняване и сливане.
Тъй като много членове на екипа могат да работят на един сайт за документация, GitBook ви позволява да създавате и управлявате отделни чернови. Можете също така да видите разликите между текущата ви чернова и копието на основната документация.
Налични са няколко вида блокове, които можете да добавите към вашите wiki страници. Това включва заглавия, абзаци, изображения, съвети, таблици, кодови блокове, прикачени файлове и др.
Как да добавите блокове за съдържание в GitBook
Можете да видите списък с наличните блокове със съдържание, които да добавите към страница. Можете да направите това, като щракнете някъде на страницата и щракнете върху плюс символ, който се появява. Можете също така директно да търсите конкретен блок със съдържание.
Можете да добавяте съдържание с помощта на Markdown. Ако не сте използвали Markdown преди, можете да научите повече за
как да започнете с Markdown. Можете също да прочетете повече за защо Markdown е толкова популярен.Как да добавяте абзаци, списъци, цитати или кодови блокове
За да добавите списъци, абзаци, цитати, кодови блокове или други прости блокове със съдържание, отворете падащото меню и изберете от наличните типове.
- На страница във вашия сайт за документация щракнете върху плюс бутон на мястото, където искате да добавите вашето съдържание.
- От падащото меню можете да превъртите списъка, за да видите различните опции за съдържание.
- Оттук изберете всеки прост тип съдържание, като абзац, кодов блок, заглавие или цитат. GitBook автоматично ще промени съдържанието, за да съответства на формата, който сте избрали.
Как да добавяте изображения или прикачени файлове
За да добавите изображения, използвайте падащото меню, за да изберете Изображения опция за блокиране на съдържание. За да добавите файлове, изберете Вмъкване на файлове опция вместо това. След това можете да използвате десния панел, за да управлявате вашите качени изображения и файлове.
- Отворете страница на вашия сайт за документация. Кликнете върху плюс бутон за отваряне на падащото меню за налични блокове със съдържание.
- Изберете Вмъкване на изображения.
- В десния панел, който се показва, има три раздела. The файлове разделът ви позволява да качите свой собствен файл с изображение. The URL адрес разделът ви позволява да се свържете към изображение онлайн. Можете също така да отворите Unplash раздел. Това е мястото, където можете да изберете съществуващи снимки, които не изискват приписване.
- След като добавите изображение, щракнете върху три точки бутон, разположен в горния ляв ъгъл на изображението. Това ще отвори падащо меню, където можете да подравните изображението или да го изтриете. Можете също така да добавите надпис към изображението.
- За да вмъкнете файлове, поставете курсора си където и да е на страница от вашия сайт за документация. Кликнете върху плюс бутон за отваряне на падащото меню с типове блокове на съдържание. Този път щракнете върху вмъкване на файлове опция.
- Ще се появи подобен десен панел, който ви позволява да качите всеки прикачен файл вместо изображение. Кликнете върху Преглед на файлове за да изберете файл, съхраняван локално на вашия компютър.
- Файлът ще се появи в списъка. Щракнете върху файла и GitBook ще създаде блок със съдържание с прикачения файл на страницата, която сте отворили. Щракването върху този блок със съдържание ще изтегли прикачения файл.
Как да добавите съвети
Можете също така да добавяте подсказки към вашата страница. Можете да промените иконата за подсказките, за да използвате червено за опасност, оранжево за предупреждение, синьо за информация или зелено за успех.
- За да добавите подсказка, щракнете върху плюс бутон за отваряне на падащото меню за налични блокове със съдържание.
- Изберете Подсказка.
- Това ще добави подсказка към вашата страница. По подразбиране типът подсказка е "информация" и съдържа синя икона.
- Можете да промените типа подсказка, като щракнете върху иконата. Това ще премине през четирите различни типа подсказки.
Как да добавите таблици
Можете да добавяте таблици, като изберете маса опция от падащия списък. След като имате таблицата на страницата, можете да добавяте нови редове или колони. Можете също така да промените имената и типовете данни на колоните и да промените данните в таблицата.
- Кликнете върху плюс бутон за отваряне на падащото меню за налични блокове със съдържание.
- Изберете Таблица.
- Кликнете върху заглавката на колона в таблицата. Това ще отвори ново по-малко меню, където можете да промените името на избраната колона. Това меню също ви позволява да изтриете или скриете избраната колона. За определени типове данни в колони можете също да подравните съдържанието вътре в колоната.
- По подразбиране избраният тип данни за колоните е „Текст“. Кликнете върху бутона с T символ за промяна на типа данни. Можете да го промените на число, квадратче за отметка, падащо меню, прикачен файл, оценка или повече.
- Кликнете върху икона с шест точки близо до горния ляв ъгъл на масата. Тук можете да вмъкнете нови колони и редове или да изтриете цялата таблица. Можете също да скриете или покажете определени колони или да промените други свойства на таблицата.
Как да добавите блокове за връзки към страници
Блоковете за връзки към страници са връзки, които заемат целия ред на страницата. Когато добавите връзката, трябва да направите връзка към страницата, която ще се отвори, когато някой кликне върху нея.
- Кликнете върху плюс бутон за отваряне на падащото меню за налични блокове със съдържание.
- Кликнете върху Връзка към страницата.
- От новото падащо меню изберете страницата, към която свързвате.
- Връзката към вашата страница ще се появи в блок на страницата.
Използване на GitBook за документация
GitBook е инструмент за документиране, който използва концепции за контрол на версиите като разклоняване и сливане. Това позволява на повече от един член на екипа да работят едновременно върху документацията. Освен това помага за справяне с възникнали конфликти.
Можете да добавяте всички видове блокове със съдържание към страница. Можете да използвате заглавия, абзаци, кодови блокове или точки, за да преформатирате съдържанието си. Можете да промените типа на подсказката, съобщението и типа на иконата на подсказките, както и да персонализирате колоните на таблица.
Разделът Файлове ви позволява да управлявате изображения и прикачени файлове, които качвате на сайта. Връзките към страници ви позволяват да създавате големи връзки, които потребителите могат лесно да забележат.
Ако създавате документация, свързана с езика Go, можете да използвате Godoc. Godoc ви позволява автоматично да документирате вашия Go код.
