6 – Синхронізація з GitHub

Загальна інформація

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

Налаштування

Перейдіть до налаштувань модифікації та прокрутіть униз до GitHub Repository URL. Вставте посилання на репозиторій та збережіть.

Якщо ваша документація знаходиться в підтеці, вкажіть шлях у Repository Path. Якщо весь репозиторій є документацією, залиште це поле порожнім.

Структура репозиторію

Ваш репозиторій повинен містити файли .md у корені вашої теки документації:

my-repo/
└── docs/
    ├── intro.md
    ├── installation.md
    └── usage.md

Кожен файл стає сторінкою у вашій вікі. Ім'я файлу (без .md) використовується як slug сторінки.

Передній план

Ви можете повідомити нашому програмному забезпеченню, як ви хочете налаштувати та відображати ваші сторінки через Frontmatter для всіх файлів Markdown (.md). Передній план має бути на початку ваших файлів.

Ось таблиця доступних полів:

Приклад

---
title: "Introduction"
order: 1
published: true
draft: false
---

# Introduction

Категорії та ієрархія

Якщо ви хочете створити дочірні сторінки під сторінкою, вам потрібно створити теку. Якщо ви хочете, щоб батьківська сторінка мала вміст, ви можете створити файл з назвою index.md та помістити вміст всередину нього. Решта сторінок у цій теці будуть дочірніми елементами теки.

Якщо ви хочете створити категорію і не хочете, щоб контент розміщувався на батьківській сторінці, ви можете створити файл meta.json, який дозволить вам змінити назву категорії тощо.

Приклад

{
  "title": "My Category",
  "published": true
}

Оновлення документації

Надсилайте зміни до свого репозиторію як завжди — вікі оновиться автоматично.

git add .
git commit -m "Update documentation"
git push