Настройка локального рабочего окружения

Для создания, редактирования и публикации документов вам потребуется любой текстовый редактор или среда разработки (IDE) с поддержкой формата Markdown и встроенной системой контроля версий Git.

Примечание

Для установки модулей и настройки авторизации в GitLab необходимо воспользоваться помощью программиста.

Вы можете использовать привычный для себя инструмент (например, WebStorm, Obsidian, Sublime Text).

Если у вас нет предпочтений, рекомендуется использовать Visual Studio Code.

Начало работы и общие сведения о `Visual Studio Code`

Visual Studio Code - бесплатный кроссплатформенный редактор, в котором по умолчанию есть все необходимые инструменты для работы.

Скачать дистрибутив Visual Studio Code можно по адресу: https://code.visualstudio.com/

Слева в верхней части интерфейса находятся вкладки, необходимые для работы.

Для документирования понадобятся:

проводник,
система управления версиями,
расширения.

Для начала работы открыть директорию с проектом выполнив действия:

выбрать файл в верхнем левом углу,
в появившемся меню нажать Открыть папку...,
найти и выбрать папку с документацией, предварительно скачанной из GitLab.

Во вкладке Проводник сверху появится строка с названием папки.

Чтобы работать с её содержимым, развернуть, нажав на её название.

Развёрнутая папка проекта:

Чтобы создать файл или папку необходимо выделить директорию и нажать на кнопку Создать файл... или Создать папку:

Содержимое открытых файлов отображается в правой части интерфейса Visual Studio Code.

Для файлов расширения Markdown (.md) по умолчанию предусмотрен предпросмотр (кнопка Открыть область предварительного просмотра справа в верхнем правом углу):