Перейти к основному содержимому

Начало работы

В данной пошаговой инструкции рассказано что необходимо сделать что бы редактировать данный сайт.

к сведению

Инструкция подходит только для операционной системы Windows.
Для операционной системы Linux действия почти аналогичны.


Первичная настройка

Необходимый софт

Для внесения изменений в документацию, Вам необходимо установить на свой ПК:

  • Git или GitHub Desktop
    • Нужен для работы с GitHub.
  • Node.js (20.x LTS):
    • Нужен для сборки локальной версии.

Клонирование репозитория

Use Ctrl + C to copy.

Установки зависимостей

В окрывшимся окне сверху в пути наберите cmd и нажмите Enter

В окне коммандной строке наберите npm i и дождитесь установки зависимостей.

После установки в коммандной строке наберите npm run start

Открылся браузер с тестовым вики? Отлично, вы готовы к созданию новый страниц/статей! (см. пункт создание страницы)

Загрузка изменений

После внесения изменений, перейдите в GitHub Desktop и выберите репозиторий wiki-editable

Слева снизу в поле Summary введите название коммита.

Нажмите кнопку Commit to master, а затем справа кнопку Push origin

Готово! Ожидайте изменений на основном сайте.

Создание нового документа

В папке с проектом перейдите в каталог docs

В нужном разделе создайте файл с вида name**.md**

Отредактируйте его используя документацию.

Полезные ссылки