Вступ

Використання локальної копії документації Rocky Linux корисно для тих, хто часто робить внесок і має потребу точно побачити, як документ виглядатиме у веб-інтерфейсі після об’єднання. Наведені тут методи відображають уподобання учасників на сьогоднішній день.

Використання локальної копії документації є одним із кроків у процесі розробки для тих, хто підтримує філософію «документи як код», робочий процес для документації, подібний до розробки коду.

Markdown linting

На додаток до середовищ для зберігання та створення документації, для деяких авторів може бути розглянутий лінтер для markdown. Лінтери Markdown корисні в багатьох аспектах написання документів, включаючи перевірку граматики, орфографії, форматування тощо. Іноді це окремі інструменти або плагіни для вашого редактора. Одним із таких інструментів є markdownlint, інструмент Node.js. markdownlint — це плагін для багатьох популярних редакторів, зокрема Visual Studio Code та NVChad. З цієї причини до кореня каталогу документації включено файл .markdownlint.yml, який застосовуватиме правила, доступні та активовані для проекту. markdownlint є суто інструментом форматування. Він перевіряє помилкові пробіли, вбудовані елементи Html, подвійні порожні рядки, неправильні табуляції тощо. Установіть інші інструменти для граматики, правопису, інклюзивного використання мови тощо.

Увага

Для жодного з пунктів цієї категорії («Локальна документація») не потрібно писати документи та подавати їх на затвердження. Вони існують для тих, хто хоче дотримуватися філософії [документи як код](https://www.writethedocs.org/guide/docs-as-code/), яка включає, як мінімум, локальну копію документації.

Author: Steven Spencer

Contributors: Ganna Zhyrnova