September 4, 2023

Создаем документацию для проекта

Сегодня я расскажу как сделать сайт по типу plasmo voice docs:

Для этого мы будем пользоваться сервисом GitBook.

Внизу будет, что у нас получится:

docs.toxxic.ru (документация моя для теста).

Приступим к гайду!

Для того что-бы создать такой сайт регестрируемся на gitbook.com.

Регистрируемся как хотим я к примеру буду регистрироваться через гугл​.

Дальше после регистрации мы находимся тут (не обращайте внимание на инструкцию по сборке тут у вас должно быть только untitled).

Тут мы можем выбрать как и что сделать синхронизировать с гитхабом или использовать шаблоны (их тут 7 штук), к примеру я использовал Product docs.

Потом изменяем все по своему вкусу!

Как изменить вещи по типу фона итд? Заходим во вкладку «customize» и делаем дела. Тут можно изменить фон итд вещи.

Сверху фон, а снизу кнопка для изменения темы.

Как выложить этот сайт в сеть и привязать домен?

Тут все легко и просто. В верхнем углу нажимаем на share.

Потом нажимаем на public to web.

Нажимаем на этот ползунок.

Поздровляю ваш сайт находится в интернете!

Приступим к добавлению домена.

Наверное вы уже сами заметили кнопку add a custom domain без меня так что нажимаем!

Тут мы пишем наш домен или под домен к примеру я напишу example.toxxic.ru.

Дальше нам выдаст это.

И дальше заходим в управление доменом у меня cloudflare добовляем днс запись CNAME.

После добавления днс записи нажимаем на:

​И ждем несколько минут если сделали правильно иногда сразу.

И воуаля сайт находится в интернете: