GitBook — это платформа, позволяющая создавать документацию и справочные сайты или корпоративные вики. Вы можете использовать его для документирования всевозможных вещей, от кода до API и того, как используется продукт приложения.
GitBook использует процесс, аналогичный репозиториям GitHub. Мастер-копия документов действует как «мастер-копия». Затем вы можете создавать «черновики», которые выглядят как «ветки». Проверять Лучшие приложения базы знаний для вашей организации.
Этот процесс позволяет нескольким пользователям работать в одном месте аутентификации, обрабатывая или предотвращая конфликты. Это также позволяет изменениям из разных ветвей проходить процесс проверки перед их слиянием.
Как начать работу с GitBook
Вики — это веб-сайт, предназначенный для групп людей, чтобы они могли быстро получать и обмениваться идеями, создавая простые страницы и связывая их вместе. Ваша компания может использовать вики по разным причинам. В больших масштабах вы можете обмениваться большими объемами информации в базе знаний организации. В меньшем масштабе вы можете использовать групповую вики для быстрого сбора и обмена идеями о проекте.
Вы можете выбрать из множества Тарифные планы GitBook. Цена будет зависеть от того, используете ли вы GitBook для проектов с открытым исходным кодом, личного использования или совместной работы в частной команде. GitBook можно использовать бесплатно, если вы используете его для проектов с открытым исходным кодом.
GitBook поддерживает язык уценка , популярный язык разметки, который имеет много преимуществ для написания или документирования в Интернете.
GitBook также интегрируется с GitHub, платформой для размещения, хранения и редактирования кода. Вы можете напрямую связать свою учетную запись GitBook со своей учетной записью GitHub, войдя в систему со своими учетными данными GitHub.
- Начните с подписки на GitBook. Если у вас есть учетная запись GitHub, вы можете нажать Зарегистрироваться с помощью GitHub.
- После входа в систему GitBook перенаправит вас на новую внутреннюю вики. Он также предварительно заполнит вики некоторым образцом контента.
Обзор интерфейса GitBook
GitBook содержит множество функций, позволяющих создать собственный сайт документации и вносить в него изменения.
- Верхняя панель позволяет создавать новые черновики, просматривать историю изменений или любые другие обсуждения или вложения.
- Боковая панель в крайнем левом углу позволяет создавать несколько областей. Вы можете использовать отдельные пространства для разных проектов, чтобы разделять и упорядочивать области документации. Вы можете развернуть или закрыть боковую панель.
- Левая панель действует как список документации сайта. Вы можете просматривать страницы на сайте документации и использовать их для создания вложенных групп и страниц. Вы также можете перемещаться по сайту, используя предоставленные ссылки.
- Нижняя панель содержит кнопки, необходимые для управления версиями. Вы можете добавить имя в черновик, внести изменение или отправить его на проверку.
Как создать новый черновик
Вы можете создать новый черновик, создав новый запрос на изменение и внеся в него изменения.
- На верхней панели коснитесь Изменить заказы.
- В новой панели, которая появится справа, нажмите на вкладку проект. Это покажет вам все ваши активные черновики.
- Отсюда вы можете щелкнуть существующий черновик, чтобы открыть его. Чтобы создать новый черновик, нажмите «Запросить новое изменение» и дождитесь завершения загрузки страницы.
- На нижней панели коснитесь Введите тему. Откроется окно, в котором вы можете назвать новый черновик. Например, Новая страница — Как настроить Codebase.
Как создавать страницы и группы
Когда у вас есть черновик, вы можете начать вносить изменения в документацию. GitBook сохраняет ваши изменения внутри черновика, поэтому они не влияют на основную копию. Вы можете использовать левую боковую панель для добавления страниц и групп страниц.
- Создайте новую страницу, нажав на ссылку новая страница Под боковой панелью выберите «Новая страница документа» в раскрывающемся меню. Кроме того, вы можете прокрутить существующую страницу вниз и нажать синюю кнопку с плюсом.
- Чтобы создать новую группу страниц, коснитесь новая страница , и выберите вариант Новая группа из раскрывающегося меню.
- Вы можете переименовать страницу, нажав кнопку «Дополнительно» (три точки) рядом со страницей или группой и выбрав переименовать.
- Начните добавлять контент, чтобы заполнить новую страницу. Вы можете добавить простое содержимое, такое как текст или заголовки. GitBook также позволяет добавлять другие блоки контента, такие как изображения, вложения файлов, таблицы, вкладки или фрагменты кода. Существует также возможность добавить другие интеграции, такие как встраивание контента YouTube или Google Docs.
- Нажмите кнопку Дифференциальный вид в нижней панели, чтобы отобразить различия между черновиком и исходной мастер-документацией.
- Когда вы закончите писать свой контент, вы можете нажать Объединить или же Отправить и объединить или же Отправить на рассмотрение.
Как создать ссылку на вики
Вы можете получить доступ к ссылке общего доступа с верхней панели в GitBook. Вам нужно будет выйти из черновика и просмотреть основную документацию, чтобы увидеть ссылку.
- По умолчанию ваш сайт аутентификации отображается как «Не в списке». Это означает, что вы можете получить доступ к сайту документации по специальной ссылке, а не через поисковые системы. На верхней панели нажмите кнопку «Не в списке».
- Выберите нужные параметры видимости из выпадающего списка. Обратите внимание, что GitBook может заблокировать определенные настройки видимости, и вам может потребоваться обновление, чтобы получить к ним доступ.
- Под меню настроек видимости есть ссылка, которой вы можете поделиться с другими пользователями, которые будут использовать вашу вики. Скопируйте эту ссылку, чтобы поделиться с другими.
- Под ссылкой нажмите «Настройки ссылки и домена». Здесь вы можете указать ссылку на собственное доменное имя или отредактировать часть URL-адреса. Если вы используете собственный домен, вы можете просмотреть документацию Gitbook о Как настроить свой DNS правильно.
Создайте вики с помощью GitBook
GitBook позволяет вам совместно создавать сайты документов или корпоративные вики и работать над ними. GitBook заимствует концепции GitHub, такие как ветки, и объединяет их для управления основной копией и управления любыми конфликтами.
Вы можете создать новый черновик, чтобы внести свои индивидуальные изменения в документы. В черновике вы можете вносить изменения в содержимое, а также добавлять новые страницы или группы страниц. Когда вы закончите вносить изменения, вы можете либо объединить их, либо отправить на проверку.
Если вы создаете внутреннюю документацию для своего кода Java, вы можете изучить Javadoc. Javadoc позволяет автоматически документировать код Java. Теперь вы можете просмотреть Как создать свою вики.
