GitBook е платформа, която ви позволява да създавате сайтове с документация или фирмени уикита. Можете да го използвате за документиране на всякакви неща, от код до API и как да използвате софтуерен продукт.

GitBook използва процес, подобен на хранилищата на GitHub. Основното копие на документацията действа като "основно" копие. След това можете да създадете "чернови", които са подобни на "клонове".

Този процес позволява на много потребители да работят на един сайт с документация, докато обработват или предотвратяват конфликти. Той също така позволява промените от различни клонове да преминат през процес на преглед, преди да ги обедините.

Как да започнете да използвате GitBook

Можете да избирате от няколко Ценообразуване на GitBook планове. Ценообразуването ще зависи от това дали използвате GitBook за проекти с отворен код, лична употреба или частно екипно сътрудничество. GitBook е безплатен за използване, ако го използвате за проекти с отворен код.

GitBook поддържа Markdown, популярен език за маркиране с много предимства за писане или документиране в мрежата.

instagram viewer

GitBook също се интегрира с GitHub, платформа за хостване, съхранение и редактиране на код. Можете да свържете своя акаунт в GitBook директно с вашия акаунт в GitHub, като влезете с вашите идентификационни данни в GitHub.

  1. Регистрирайте се в GitBook. Ако имате собствен акаунт в GitHub, можете да кликнете върху Регистрирайте се с GitHub.
  2. След като влезете, GitBook ще ви пренасочи към ново вътрешно wiki. Освен това ще попълни предварително вашето wiki с малко примерно съдържание.

Общ преглед на интерфейса на GitBook

GitBook има няколко функции, които ви позволяват да създавате и правите промени във вашия сайт с документация.

  1. Горният панел ви позволява да създавате нови чернови, да преглеждате хронологията на промените или да преглеждате други дискусии или прикачени файлове.
  2. Най-лявата странична лента ви позволява да създавате множество интервали. Можете да използвате отделни пространства за различни проекти, така че да можете да отделите и организирате своите области за документация. Можете да разширите или затворите страничната лента.
  3. Левият панел действа като меню за сайта с документация. Можете да преглеждате страниците във вашия сайт за документация и да го използвате за създаване на групи и вложени страници. Можете също да навигирате в сайта, като използвате предоставените връзки.
  4. Долният панел включва бутони, които са жизненоважни за процеса на контрол на версиите. Можете да добавите име за вашата чернова, да обедините промяна или да изпратите промяната за преглед.

Как да създадете нова чернова

Можете да създадете нова чернова, като създадете нова заявка за промяна и направите промени в нея.

  1. В горния панел щракнете върху Заявки за промяна.
  2. В новия панел, който се появява от дясната страна, щракнете върху Чернова раздел. Това ще ви покаже всичките ви активни чернови.
  3. От тук можете да щракнете върху съществуваща чернова, за да я отворите. За да създадете нова чернова, щракнете върху Нова заявка за промянаи изчакайте страницата да приключи зареждането.
  4. В долния панел щракнете върху Въведете тема. Това ще отвори прозорец, където можете да дадете име на новата чернова. Например, Нова страница - Как да настроите кодова база.

Как да създадете страници и групи

След като имате чернова, можете да започнете да правите промени в документацията. GitBook съхранява вашите промени в черновата, така че те не засягат главното копие. Можете да използвате лявата странична лента, за да добавяте страници и групи страници.

  1. Създайте нова страница, като щракнете върху Нова страница връзка в долната част на страничната лента и избиране Нова страница на документа от падащото меню. Като алтернатива можете да задържите курсора на мишката под съществуваща страница и да щракнете върху синьото плюс бутон.
  2. За да създадете нова група страници, щракнете върху Нова страницаи изберете Нова група опция от падащото меню.
  3. Можете да преименувате страницата, като щракнете върху трите точки до страницата или групата и изберете Преименуване.
  4. Започнете да добавяте съдържание, за да попълните новата си страница. Можете да добавите просто съдържание като текст или заглавия. GitBook също ви позволява да добавяте други блокове със съдържание като изображения, прикачени файлове, таблици, раздели или кодови фрагменти. Има и опция за добавяне на други интеграции, като вграждане в YouTube или съдържание на Google Документи.
  5. Кликнете върху Различен изглед в долния панел, за да видите разликите между вашата чернова и оригиналното копие на основната документация.
  6. След като приключите с писането на вашето съдържание, можете да щракнете върху Обединяване, Изпратете и обединете, или Изпратете за преглед.

Можете да получите достъп до връзката за споделяне от горния панел на GitBook. Ще трябва да сте извън черновата и да преглеждате копието на основната документация, за да можете да видите връзката.

  1. По подразбиране видимостта на вашия сайт с документация е „скрита“. Това означава, че можете да получите достъп до сайта с документация чрез лична връзка, а не чрез търсачки. В горния панел щракнете върху Скрит бутон.
  2. Изберете желаните настройки за видимост от падащото меню. Имайте предвид, че GitBook може да заключи определени настройки за видимост и може да се наложи да надстроите, за да имате достъп до тях.
  3. Под списъка с настройки за видимост има връзка, която можете да споделите с други потребители, които ще използват вашия сайт за документация. Копирайте тази връзка, за да я споделите с други.
  4. Под връзката щракнете върху Настройки за връзка и домейн. Това е мястото, където можете да свържете потребителско име на домейн или да промените част от URL адреса. Ако използвате потребителски домейн, можете да видите Документация на Gitbook как да конфигурирате правилно вашия DNS.

Създаване на документация с помощта на GitBook

GitBook ви позволява да създавате съвместно и да работите върху сайтове с документация или фирмени уикита. GitBook заимства концепции от GitHub като клонове и сливане, за да контролира главно копие и да управлява всички конфликти.

Можете да създадете нова чернова, за да добавите свои собствени индивидуални промени към документацията. В черновата можете да правите промени в съдържанието, както и да добавяте нови страници или групи страници. След като приключите с вашите промени, можете или да ги обедините, или да ги изпратите за преглед.

Ако създавате вътрешна документация за вашия Java код, може да искате да проучите Javadoc. Javadoc ви позволява да документирате вашия Java код автоматично.