GitBook, напиши документацію для своїх проектів з Ubuntu

У наступній статті ми збираємось поглянути на GitBook. Це одне крос-платформний графічний інтерфейс, основною функцією якого є перенесення робочого процесу GitBook на наш робочий стіл в Ubuntu. Подивившись на його інтерфейс, ви побачите, що він добре продуманий для редагування тексту та роботи з попереднім переглядом проекту.

GitBook був створений в середині 2014 року. Він народився з метою створити Сучасне та просте рішення для створення документів, цифрового письма та публікації вмісту. Філософія проекту полягає в тому, щоб бути простим, не втрачаючи точки елегантності. Відволікання та занепокоєння творців вмісту усуваються, тому вони можуть вільно писати.

Сотні тисяч користувачів використовують GitBook для написати документацію (бібліотека, API, інструменти тощо) або бази знань (наприклад, поширені запитання). Люди також використовують цю програму для видання технічних книг, навчальних матеріалів та багатьох інших речей.

Загальні характеристики GitBook

Це Інтернет-платформа для написання та розміщення документації. Він надає формат книги з відкритим кодом та набори інструментів.

Ця програма запропонує нам вбудовані елементи керування Git. Ми також матимемо у своєму розпорядженні панель змісту, панель дерева файлів та кнопки швидкого форматування для полегшення структуризації наших документів.

Крім того, GitBook пропонує нам можливість відображати наш вміст як веб-сайт (настроюється та розширюється) або як електронна книга (PDF, ePub або Mobi).

GitBook.com - це онлайн-платформа для створення та розміщення книг, створених у форматі програми. Пропонує хостинг, функції співпраці та простий у використанні редактор. Ця програма дозволяє використовувати нашу команду для створення місцевих книг на GitHub або на платформі для їх розміщення.

Щоб розпочати використання цієї програми, творці надають користувачам можливість проконсультуватися з Інструкції з Інсталяції в документації. Якщо будь-який користувач хоче або потребує цього, він може проконсультуватися з вихідним кодом цієї програми на сторінці GitHub цієї програми.

Встановлення GitBook

Якщо ви хочете завантажити пакет програм, ви можете завантажити його з вашого Офіційний сайт. Там ми можемо завантажте його за допомогою браузера. Ми також можемо отримати пакет за допомогою команда wget відкриття терміналу (Ctrl + Alt + T) і введення в нього такого:

wget http://downloads.editor.gitbook.com/download/linux-64-bit

Після завантаження пакету ми можемо встановити його, виконавши в цьому ж терміналі таку команду:

dpkg -i linux-64-bit

Після завершення інсталяції ви зможете скористатися полем пошуку на Ubuntu Dash і набрати gitbook. На екрані відображатиметься значок програми.

Коли ми ввійшли в систему, або за допомогою Обліковий запис GitBook або за допомогою нашого облікового запису в соціальних мережах, тепер ми можемо створити нову Книгу. Ми можемо зробити це, натиснувши опцію Нова книга, доступну на екрані.

Тепер можна починати напишіть власну Книгу в редакторі. Не забудьте вибрати в редакторі сховище, куди ми хочемо завантажити зміни.

Як синхронізувати Gitbook з Github?

Щось дуже цікаве в цій програмі полягає в тому, що вона пропонує нам можливість працювати з GitHub. Я читав, що для деяких людей це було проблемою синхронізувати сховище Github з платформою GitBook.

Перше, що нам доведеться зробити, це створити загальнодоступне сховище на Github. Нам також знадобиться створити книгу в Інтернеті Gitbook. Це рекомендується, хоча я думаю, що не важливо, щоб обидва сховища мали однакову назву.

Після створення книги важливо отримати доступ до Інструменти налаштування книг та перейдіть до розділу Github. Потрапивши всередину, ви продовжите оберіть інтеграцію зі сховищем GitHub з яким потрібно синхронізувати. Після вибору сховища ми продовжуватимемо приймати та зберігати весь процес.

Після того, як цю операцію було виконано, якщо все пішло добре, повинно з'явитися зелене повідомлення із зазначенням, що інтеграція з Github це працює.

Щоб перевірити, чи все працює. Тепер ми розпочнемо сеанс з клієнта GitBook, який ми встановили в нашому Ubuntu. Коли він починається, ми можемо внести зміни, які ми вважаємо доречними. Тепер ми можемо завантажити їх у наш нещодавно створений Репозиторій GitHub.