2022-08-18 18:46:04 +00:00
# Як працювати над документацією
2022-06-17 16:10:07 +00:00
2022-08-18 18:46:04 +00:00
## Робота над вмістом документації
2022-06-17 16:10:07 +00:00
2022-08-18 18:46:04 +00:00
Щоб працювати над рекомендаціями щодо внеску, ви можете редагувати а б о додавати файли в каталозі `docs` , [доступному тут ](https://github.com/freeCodeCamp/freeCodeCamp/tree/main/docs ). Коли ваші зміни о б 'єднані, вони стануть автоматично доступними на документаційному сайті.
2022-06-17 16:10:07 +00:00
2022-08-18 18:46:04 +00:00
### Як створити внутрішнє посилання
2022-06-17 16:10:07 +00:00
2022-08-18 18:46:04 +00:00
Якщо ви хочете створити внутрішнє посилання, націлене на інший розділ рекомендацій щодо внеску, слідуйте цьому формату:
2022-06-17 16:10:07 +00:00
```md
[Link text ](target-file-name.md#target-section-heading-id )
2022-08-18 18:46:04 +00:00
// Якщо цільовий розділ знаходиться на тій же сторінці, ви можете опустити назву файлу
2022-06-17 16:10:07 +00:00
[Link text ](#target-section-heading-id )
```
2022-08-18 18:46:04 +00:00
Переконайтеся, що включили розширення файлу (`.md`). Н е вказуйте повну URL-адресу а б о додайте `/` перед назвою файлу.
2022-06-17 16:10:07 +00:00
2022-08-18 18:46:04 +00:00
Це обов'язково для того, щоб посилання працювали для перекладеної версії документа. В іншому випадку вони перенаправлятимуть на англійську версію сторінки, незалежно від мови.
2022-06-17 16:10:07 +00:00
2022-08-18 18:46:04 +00:00
#### Переклад документації з внутрішніми посиланнями
2022-06-17 16:10:07 +00:00
2022-08-18 18:46:04 +00:00
Коли ви працюєте над перекладом документації на Crowdin, не забудьте змінити `#target-section-heading-id` на ідентифікацію в перекладеному документі. [Дізнатись більше про переклад документації ](how-to-translate-files.md#translate-documentation ).
2022-06-17 16:10:07 +00:00
2022-08-18 18:46:04 +00:00
## Робота над темою документації
2021-12-10 05:49:29 +00:00
2022-08-18 18:46:04 +00:00
> [!NOTE] Швидке нагадування, що вам не потрібно нічого налаштовувати для роботи над вмістом документації.
2021-12-10 05:49:29 +00:00
>
2022-08-18 18:46:04 +00:00
> Щоб працювати над рекомендаціями щодо внеску, див. розділ [робота над вмістом документації](#work-on-the-docs-content).
2021-12-10 05:49:29 +00:00
2022-08-18 18:46:04 +00:00
### Структура вебсайту документації
2021-12-10 05:49:29 +00:00
2022-08-18 18:46:04 +00:00
Сайт створений з використанням [`docsify` ](https://docsify.js.org ) та обслуговується завдяки GitHub Pages.
2021-12-10 05:49:29 +00:00
2022-08-18 18:46:04 +00:00
Зазвичай вам не потрібно буде змінювати конфігурації а б о створювати сайт локально. Хочете дізнатись більше? Ось як це працює:
2021-12-10 05:49:29 +00:00
2022-08-18 18:46:04 +00:00
- Джерело домашньої сторінки для цього сайту доступне в [`docs/index.html` ](index.html ).
- Ми обслуговуємо цей файл як SPA, використовуючи `docsify` та GitHub Pages.
- Скрипт `docsify` генерує вміст файлів `markdown` в каталозі `docs` за запитом.
- Домашня сторінка генерується з [`_coverpage.md` ](_coverpage.md ).
- Навігація бічної панелі генерується з [`_sidebar.md` ](_sidebar.md ).
2021-12-10 05:49:29 +00:00
2022-08-18 18:46:04 +00:00
### Обслуговування документаційного сайту локально
2021-12-10 05:49:29 +00:00
2022-08-18 18:46:04 +00:00
Клонуйте freeCodeCamp:
2021-12-10 05:49:29 +00:00
```console
git clone https://github.com/freeCodeCamp/freeCodeCamp.git
```
2022-08-18 18:46:04 +00:00
Встановіть `docsify` :
2021-12-10 05:49:29 +00:00
```console
npm install -g docsify
```
2022-08-18 18:46:04 +00:00
та обслужіть каталог `/docs`
2021-12-10 05:49:29 +00:00
```console
docsify serve docs
```
2022-08-18 18:46:04 +00:00
Іншим чином, якщо ви встановили freeCodeCamp локально (див. посібник з локального налаштування), ми зібрали CLI з інструментами веброзробки, щоб ви могли запустити будь-яку з наведених нижче команд, необхідних з кореня репозиторію:
2021-12-10 05:49:29 +00:00
2022-08-18 18:46:04 +00:00
#### Обслужити та запустити лише документаційний сайт
2021-12-10 05:49:29 +00:00
```console
npm run docs:serve
```
2022-08-18 18:46:04 +00:00
#### Обслужити документаційний сайт поряд з freeCodeCamp локально:
2021-12-10 05:49:29 +00:00
```console
npm run develop
```
2022-08-18 18:46:04 +00:00
> Документаційний сайт повинен бути доступний на <http://localhost:3200>