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

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

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

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

Visual Studio Code

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

Скачать дистрибутив: https://code.visualstudio.com/

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

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

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

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

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

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

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

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

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

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

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

Выбрать действие над файлом или папкой можно вызвав контекстное меню, нажатием правой кнопки мыши:

Установка русского языка для интерфейса Visual Studio Code

Ввести команду: Ctrl + Shift + P, в верху экрана посередине появится поле ввода команд.

Ввести команду Configure Display Language и нажать Enter.

Ввести русский и нажать Enter.

Нажимаем restart, тем самым перезапуская Visual Studio Code и применяя русский интерфейс к программе:

Расширения

Russian - Code Spell Checker - автоматически проверяет орфографию.

Установка расширения:

• перейти во вкладку Расширения,
• ввести в поиск Russian - Code Spell Checker,
• нажать синюю кнопку install.

После установки нажать F1 (появится поле ввода вверху экрана) и ввести в поле:

• Enable Russian Spell Checker Dictionary, нажать Enter.
• Disable Russian Spell Checker Dictionary in Workspace, нажать Enter.

Настройка завершена.

EasyMarkdown - добавляет некоторые функции в интерфейс Visual Studio Code для быстрого редактирования Markdown:

Добавленные функции:

Система контроля версий GIT

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