4.7 KiB
Як працювати над документацією
Робота над вмістом документації
Щоб працювати над рекомендаціями щодо внеску, ви можете редагувати або додавати файли в каталозі docs
, доступному тут. Коли ваші зміни об'єднані, вони стануть автоматично доступними на документаційному сайті.
Як створити внутрішнє посилання
Якщо ви хочете створити внутрішнє посилання, націлене на інший розділ рекомендацій щодо внеску, слідуйте цьому формату:
[Link text](target-file-name.md#target-section-heading-id)
// Якщо цільовий розділ знаходиться на тій же сторінці, ви можете опустити назву файлу
[Link text](#target-section-heading-id)
Переконайтеся, що включили розширення файлу (.md
). Не вказуйте повну URL-адресу або додайте /
перед назвою файлу.
Це обов'язково для того, щоб посилання працювали для перекладеної версії документа. В іншому випадку вони перенаправлятимуть на англійську версію сторінки, незалежно від мови.
Переклад документації з внутрішніми посиланнями
Коли ви працюєте над перекладом документації на Crowdin, не забудьте змінити #target-section-heading-id
на ідентифікацію в перекладеному документі. Дізнатись більше про переклад документації.
Робота над темою документації
[!NOTE] Швидке нагадування, що вам не потрібно нічого налаштовувати для роботи над вмістом документації.
Щоб працювати над рекомендаціями щодо внеску, див. розділ робота над вмістом документації.
Структура вебсайту документації
Сайт створений з використанням docsify
та обслуговується завдяки GitHub Pages.
Зазвичай вам не потрібно буде змінювати конфігурації або створювати сайт локально. Хочете дізнатись більше? Ось як це працює:
- Джерело домашньої сторінки для цього сайту доступне в
docs/index.html
. - Ми обслуговуємо цей файл як SPA, використовуючи
docsify
та GitHub Pages. - Скрипт
docsify
генерує вміст файлівmarkdown
в каталозіdocs
за запитом. - Домашня сторінка генерується з
_coverpage.md
. - Навігація бічної панелі генерується з
_sidebar.md
.
Обслуговування документаційного сайту локально
Клонуйте freeCodeCamp:
git clone https://github.com/freeCodeCamp/freeCodeCamp.git
Встановіть docsify
:
npm install -g docsify
та обслужіть каталог /docs
docsify serve docs
Іншим чином, якщо ви встановили freeCodeCamp локально (див. посібник з локального налаштування), ми зібрали CLI з інструментами веброзробки, щоб ви могли запустити будь-яку з наведених нижче команд, необхідних з кореня репозиторію:
Обслужити та запустити лише документаційний сайт
npm run docs:serve
Обслужити документаційний сайт поряд з freeCodeCamp локально:
npm run develop
Документаційний сайт повинен бути доступний на http://localhost:3200