Как создать простую внутреннюю вики с помощью Gitbook

Как создать простую внутреннюю вики с помощью Gitbook

GitBook — это платформа, позволяющая создавать сайты с документацией или корпоративные вики. Вы можете использовать его для документирования всевозможных вещей, от кода до API и того, как использовать программный продукт.





GitBook использует аналогичный процесс для репозиториев GitHub. Основная копия документации выступает в роли «главной» копии. Затем вы можете создавать «черновики», похожие на «ветки».



Этот процесс позволяет многим пользователям работать с одним сайтом документации, обрабатывая или предотвращая конфликты. Это также позволяет изменениям из разных ветвей пройти процесс проверки перед их объединением.





Как начать использовать GitBook

Вы можете выбрать из нескольких Цены на GitBook планы. Цена будет зависеть от того, используете ли вы GitBook для проектов с открытым исходным кодом, личного использования или совместной работы в частной команде. GitBook можно использовать бесплатно, если вы используете его для проектов с открытым исходным кодом.

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



GitBook также интегрируется с GitHub — платформа для размещения, хранения и редактирования кода. . Вы можете связать свою учетную запись GitBook напрямую с учетной записью GitHub, войдя в систему, используя свои учетные данные GitHub.

  1. Зарегистрируйтесь на Гитбуке. Если у вас есть собственная учетная запись GitHub, вы можете нажать Зарегистрироваться на GitHub .
  2. Как только вы войдете в систему, GitBook перенаправит вас на новую внутреннюю вики. Он также предварительно заполнит вашу вики некоторым образцом контента.

Обзор интерфейса GitBook

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



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

Как создать новый черновик

Вы можете создать новый черновик, создав новый запрос на изменение и внеся в него изменения.

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

Как создавать страницы и группы

Когда у вас есть черновик, вы можете начать вносить изменения в документацию. GitBook сохраняет ваши изменения внутри черновика, поэтому они не влияют на мастер-копию. Вы можете использовать левую боковую панель для добавления страниц и групп страниц.



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

Вы можете получить доступ к ссылке общего доступа с верхней панели GitBook. Вам нужно будет выйти из черновика и просмотреть основную копию документации, чтобы иметь возможность просмотреть ссылку.

  1. По умолчанию видимость вашего сайта документации 'вне списка'. Это означает, что вы можете получить доступ к сайту документации по закрытой ссылке, а не через поисковые системы. На верхней панели нажмите кнопку Вне списка кнопка.
  2. Выберите нужные параметры видимости из раскрывающегося списка. Обратите внимание, что GitBook может заблокировать определенные настройки видимости, и вам может потребоваться обновление, чтобы получить к ним доступ.
  3. Под списком настроек видимости есть ссылка, которой вы можете поделиться с другими пользователями, которые будут использовать ваш сайт документации. Скопируйте эту ссылку, чтобы поделиться ею с другими.
  4. Под ссылкой нажмите на Ссылка и настройки домена . Здесь вы можете связать собственное доменное имя или изменить часть URL-адреса. Если вы используете личный домен, вы можете просмотреть Документация Gitbook о том, как правильно настроить свой DNS.

Создание документации с помощью GitBook

GitBook позволяет вам совместно создавать сайты документации или корпоративные вики и работать над ними. GitBook заимствует у GitHub такие концепции, как ветки и слияние, для управления основной копией и управления любыми конфликтами.

как узнать, какое личное видео было на YouTube

Вы можете создать новый черновик, чтобы добавить свои индивидуальные изменения в документацию. В черновике вы можете вносить изменения в содержимое, а также добавлять новые страницы или группы страниц. Когда вы закончите вносить изменения, вы можете либо объединить их, либо отправить на проверку.

Если вы создаете внутреннюю документацию для своего кода Java, вы можете изучить Javadoc. Javadoc позволяет автоматически документировать код Java.