19 lines
3.0 KiB
HTML
19 lines
3.0 KiB
HTML
<!--
|
||
title: Сервис документации Gitbook
|
||
description:
|
||
published: true
|
||
date: 2024-07-09T09:50:06.265Z
|
||
tags:
|
||
editor: ckeditor
|
||
dateCreated: 2023-11-15T16:25:24.896Z
|
||
-->
|
||
|
||
<p>Хочу рассказать вам про удобный сервис для создания документации - Gitbook. Он работает по модели SaaS с бесплатным тарифным планом. С его помощью можно вести документацию в обычном git репозитории, а затем публиковать в виде веб сайта, а так же электронной книги в формате PDF, ePub или Mobi (платные функции).</p>
|
||
<p>Пример подобной документации можно оценить по очень известной серии статей на тему настройки сети - Сети для самых маленьких (<a href="https://linkmeup.gitbook.io/sdsm/">https://linkmeup.gitbook.io/sdsm/</a>). Они с некоторых пор живут на gitbook. Думаю, вы часто сталкивались с документацией на этом сервисе. Он популярен.</p>
|
||
<p>Одно время у Gitbook был опенсорсный клиент с cli (<a href="https://github.com/GitbookIO/gitbook">https://github.com/GitbookIO/gitbook</a>), который можно было поставить на Linux. С его помощью можно было локально вести документацию и синхронизировать с сервисом. Но не так давно его перестали поддерживать и развивать, хотя он пока всё ещё работает.</p>
|
||
<p>Я не совсем понял, что там с оплатой. Заявлен бесплатный тарифный план для open source проектов. При этом я без проблем зарегистрировался и нигде не увидел ограничений или срок действия триала, если он активирован. Проверил очень старые проекты, где вели документацию еще несколько лет назад, они все живы, доки открываются по старым ссылкам, хотя проекты уже мёртвые и давно не обновлялись.</p>
|
||
<p>В общем, если ищите инструмент для ведения документации, посмотрите на Gitbook. Это удобное специализированное решение для этих целей.</p>
|
||
<p>Посмотреть, как всё это работает:<br><a href="https://www.youtube.com/watch?v=KzOcIopMNjU">https://www.youtube.com/watch?v=KzOcIopMNjU</a></p>
|
||
<p> </p>
|
||
<figure class="image"><img src="/attachments/image2022-8-11_10-45-46.png"></figure>
|