Менше хвилини читання
У цьому розділі йдеться про налаштування різноманітних генераторів статичних сайтів.
У цих інструкціях я розповім про мій досвід налаштування генераторів статичних сайтів: Jekyll, Hugo тощо.
Коли я вперше почав вивчати CI / CD та SSG, першим генератором, про який я дізнався, був Jekyll. Я використав Початок роботи з темою документації для Jekyll Тома Джонсона, відомого гуру техрайтерів, відомого завдяки своєму блогу I’d Rather Be Writing. Тож, без зайвих слів, давайте створимо наш перший сайт з документацією, використовуючи тему Тома для Jekyll. Я спробую пояснити навіть очевидні речі.
У певний момент ви починаєте шукати спосіб створити сайт для документації API. Так, усі ці ендпойнти API, виклики, запити та параметри, проілюстровані блоками коду. Том Джонсон у своєму посібнику Documenting APIs для технічних письменників згадує тему Aviator для Jekyll як приклад сайту для документації API. Опублікуємо цей сайт, дотримуючись інструкцій нижче.
Одним із моїх перших проектів на Jekyll було моє резюме у вигляді односторінкового сайта. Хоча багато HR та рекрутерів усе ще віддають перевагу класичному PDF, я вирішив спробувати зробити онлайн-резюме. Зрештою, так просто надіслати посилання на своє резюме. У цій статті я покажу, як створити своє онлайн-резюме, використовуючи Jekyll як генератор статичних сайтів і Vercel для компіляції та розміщення вашого сайта в інтернеті.
Hugo був моїм другим генератором статичних сайтів після Jekyll. Зараз це мій улюблений SSG. Він має багато приємних функцій, але його найсильніша перевага — це час збірки, що є найшвидший серед усіх інших SSG. У цій статті я покажу, як встановити Hugo на Windows.
Іноді вам потрібно видалити або деінсталювати Hugo, який ви встановили на Windows. Мені не вдалося знайти інструкції в інтернеті. Ось спосіб видалити Hugo зі свого комп’ютера.
Я створив близько 10 різних сайтів за допомогою Hugo. Поки що це мій улюблений генератор статичних сайтів. Швидкість компіляції — менше хвилини для кожного сайту, що я опублікував. Однак процес налаштування сайтів Hugo для мене не дуже зрозумілий. Я хотів би мати чіткі інструкції, як додати тему та опублікувати сайт в Інтернеті. Багато тем Hugo доступні на JAMstack Themes.
У цій статті я розповім про підхід docs-as-code (документація як код) для створення документації у вигляді статичного сайта за допомогою Docusaurus — генератора статичних сайтів (static site generator). Окрім загальної інформації про сучасний підхід до створення документації, я пропоную покрокову інструкцію, як створити сайт із документацією без знання мови програмування, а також опублікувати цей сайт в інтернеті.
У цій статті я пояснюю, як опублікувати сайт на Docusaurus у GitLab Pages за допомогою файлу конфігурації CI. Це альтернативний спосіб публікації сайту на Docusaurus у GitLab вашої компанії чи вашого власного облікового запису GitLab.
Was this page helpful?
Glad to hear it! Please tell us how we can improve.
Sorry to hear that. Please tell us how we can improve.