GitBook — это платформа, которая позволяет вам и вашей команде создавать сайты документации и совместно работать над ними. GitBook делает это, используя концепции управления версиями, такие как ветвление и слияние.
Поскольку над одним сайтом документации могут работать многие члены команды, GitBook позволяет создавать отдельные черновики и управлять ими. Вы также можете просмотреть различия между вашим текущим черновиком и основной копией документации.
Вы можете добавить несколько типов блоков на свои вики-страницы. Сюда входят заголовки, абзацы, изображения, подсказки, таблицы, блоки кода, вложенные файлы и многое другое.
Как добавить блоки контента в GitBook
Вы можете просмотреть список доступных блоков контента для добавления на страницу. Это можно сделать, щелкнув в любом месте страницы и щелкнув значок плюс появившийся символ. Вы также можете напрямую искать определенный блок контента.
Вы можете добавлять контент с помощью Markdown. Если вы раньше не использовали Markdown, вы можете узнать больше о
как начать работу с уценкой. Вы также можете прочитать больше о почему Markdown так популярен.Как добавить абзацы, списки, цитаты или блоки кода
Чтобы добавить списки, абзацы, цитаты, блоки кода или другие простые блоки контента, откройте раскрывающийся список и выберите один из доступных типов.
- На странице вашего сайта документации щелкните значок плюс кнопку в том месте, где вы хотите добавить свой контент.
- В раскрывающемся списке вы можете прокрутить список, чтобы просмотреть различные варианты содержимого.
- Отсюда выберите любой простой тип содержимого, например абзац, блок кода, заголовок или цитату. GitBook автоматически изменит содержимое в соответствии с выбранным вами форматом.
Как добавить изображения или вложенные файлы
Чтобы добавить изображения, используйте раскрывающийся список, чтобы выбрать Картинки возможность блокировки контента. Чтобы добавить файлы, выберите Вставить файлы вместо этого вариант. Затем вы можете использовать правую панель для управления загруженными изображениями и файлами.
- Откройте страницу на вашем сайте документации. Нажми на плюс кнопку, чтобы открыть раскрывающийся список доступных блоков контента.
- Выбирать Вставить изображения.
- В появившейся правой панели есть три вкладки. Файлы Вкладка позволяет загрузить собственный файл изображения. URL-адрес вкладка позволяет сделать ссылку на изображение онлайн. Вы также можете открыть Скрыть вкладка Здесь вы можете выбрать существующие фотографии, не требующие указания авторства.
- После того, как вы добавили изображение, нажмите на кнопку три точки Кнопка, расположенная в верхнем левом углу изображения. Откроется раскрывающийся список, в котором вы можете выровнять изображение или удалить его. Вы также можете дать изображение подписи.
- Чтобы вставить файлы, поместите курсор в любое место на странице вашего сайта документации. Нажми на плюс Кнопка, чтобы открыть раскрывающийся список типов блоков контента. На этот раз нажмите на вставить файлы вариант.
- Появится аналогичная правая панель, позволяющая загрузить любой вложенный файл вместо изображения. Нажмите на Просмотр файлов чтобы выбрать файл, хранящийся локально на вашем компьютере.
- Файл появится в списке. Нажмите на файл, и GitBook создаст блок контента с вложенным файлом на странице, которую вы открыли. Нажав на этот блок содержимого, вы загрузите вложенный файл.
Как добавить подсказки
Вы также можете добавить подсказки на свою страницу. Вы можете изменить значок для подсказок, чтобы использовать красный цвет для опасности, оранжевый для предупреждения, синий для информации или зеленый для успеха.
- Чтобы добавить подсказку, нажмите на кнопку плюс кнопку, чтобы открыть раскрывающийся список доступных блоков контента.
- Выбирать Намекать.
- Это добавит подсказку на вашу страницу. По умолчанию тип подсказки — «информация» и содержит синий значок.
- Вы можете изменить тип подсказки, нажав на значок. Это будет перебирать четыре разных типа подсказок.
Как добавить таблицы
Вы можете добавить таблицы, выбрав стол вариант из выпадающего списка. Когда у вас есть таблица на странице, вы можете добавить новые строки или столбцы. Вы также можете изменить имена и типы данных столбцов и изменить данные внутри таблицы.
- Нажми на плюс кнопку, чтобы открыть раскрывающийся список доступных блоков контента.
- Выбирать Стол.
- Нажмите на заголовок столбца в таблице. Это откроет новое меньшее меню, где вы можете изменить имя выбранного столбца. Это меню также позволяет вам удалить или скрыть выбранный столбец. Для определенных типов данных столбца вы также можете выровнять содержимое внутри столбца.
- По умолчанию для столбцов выбран тип данных «Текст». Нажмите на кнопку с Т символ для изменения типа данных. Вы можете изменить его на число, флажок, раскрывающийся список, вложение файла, рейтинг и т. д.
- Нажми на значок шесть точек возле верхнего левого угла таблицы. Здесь вы можете вставить новые столбцы и строки или удалить всю таблицу. Вы также можете скрыть или показать определенные столбцы или изменить другие свойства таблицы.
Как добавить блоки ссылок на страницы
Блоки ссылок на страницы — это ссылки, занимающие всю строку на странице. Когда вы добавляете ссылку, вы должны указать ссылку на страницу, которая будет открываться, когда кто-то нажимает на нее.
- Нажми на плюс кнопку, чтобы открыть раскрывающийся список доступных блоков контента.
- Нажмите на Ссылка на страницу.
- В новом раскрывающемся списке выберите страницу, на которую вы ссылаетесь.
- Ссылка на вашу страницу появится внутри блока на странице.
Использование GitBook для документации
GitBook — это инструмент для документирования, в котором используются такие концепции управления версиями, как ветвление и слияние. Это позволяет более чем одному члену команды одновременно работать над документацией. Это также помогает управлять любыми конфликтами, которые возникают.
Вы можете добавлять на страницу все виды блоков контента. Вы можете использовать заголовки, абзацы, блоки кода или маркеры для переформатирования содержимого. Вы можете изменить тип подсказки, сообщение и тип значка подсказки, а также настроить столбцы таблицы.
Вкладка «Файлы» позволяет управлять изображениями и вложенными файлами, которые вы загружаете на сайт. Ссылки на страницы позволяют создавать большие ссылки, которые пользователи могут легко заметить.
Если вы создаете документацию, связанную с языком Go, вы можете использовать Godoc. Godoc позволяет автоматически документировать ваш код Go.
