Перейти к содержанию

Настройка локального рабочего окружения: различия между версиями

Материал из Химсофт Вики
Новая страница: «==Настройка локального рабочего окружения== Для создания, редактирования и публикации документов вам потребуется любой текстовый редактор или среда разработки (<code>IDE</code>) с поддержкой формата <code>Markdown</code> и встроенной системой контроля версий <code>Git</code>...»
 
 
(не показано 10 промежуточных версий этого же участника)
Строка 1: Строка 1:
==Настройка локального рабочего окружения==
Для создания, редактирования и публикации документов вам потребуется любой текстовый редактор или среда разработки (<code>IDE</code>) с поддержкой формата <code>Markdown</code> и встроенной системой контроля версий <code>Git</code>.
Для создания, редактирования и публикации документов вам потребуется любой текстовый редактор или среда разработки (<code>IDE</code>) с поддержкой формата <code>Markdown</code> и встроенной системой контроля версий <code>Git</code>.
<div style="background-color: #e7f3ff; border-left: 5px solid #2196f3; padding: 15px; margin: 10px 0;">
'''Примечание'''
*Для установки <code>Git</code> и настройки авторизации в <code>GitLab</code> необходимо воспользоваться помощью программиста.
</div>


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


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


Скачать дистрибутив: https://code.visualstudio.com/
==Начало работы и общие сведения о Visual Studio Code==


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


'''Начало работы и общие сведения'''
Скачать дистрибутив <code>Visual Studio Code</code> можно по адресу: https://code.visualstudio.com/


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


[[Файл:Vsc_3.png|center]]
[[Файл:Vsc_3.png|center]]
 
<br>
[[Файл:Vsc_4.png|center]]
[[Файл:Vsc_4.png|center]]


Строка 49: Строка 54:


[[Файл:Vsc_8.png|center]]
[[Файл:Vsc_8.png|center]]
 
<br>
[[Файл:Vsc_9.png|1200px|center]]
[[Файл:Vsc_9.png|1200px|center]]


Строка 56: Строка 61:
[[Файл:Vsc_10.png|center]]
[[Файл:Vsc_10.png|center]]


'''Установка русского языка для интерфейса <code>Visual Studio Code</code>'''
==Установка русского языка для интерфейса <code>Visual Studio Code</code>==


Ввести команду: <code>Ctrl</code> + <code>Shift</code> + <code>P</code>, в верху экрана посередине появится поле ввода команд.
Ввести команду: <code>Ctrl</code> + <code>Shift</code> + <code>P</code>, в верху экрана посередине появится поле ввода команд.
Строка 72: Строка 77:
[[Файл:Vsc_13.png|center]]
[[Файл:Vsc_13.png|center]]


'''Расширения'''
==Расширения==


<code>Russian - Code Spell Checker</code> - автоматически проверяет орфографию.
===Russian - Code Spell Checker===
 
Расширение <code>Russian - Code Spell Checker</code> - автоматически проверяет орфографию.


Установка расширения:
Установка расширения:
Строка 91: Строка 98:
Настройка завершена.
Настройка завершена.


<code>EasyMarkdown</code> - добавляет некоторые функции в интерфейс <code>Visual Studio Code</code> для быстрого редактирования <code>Markdown</code>:
===EasyMarkdown===
 
Расширение <code>EasyMarkdown</code> - добавляет некоторые функции в интерфейс <code>Visual Studio Code</code> для быстрого редактирования <code>Markdown</code>:


[[Файл:Vsc_16.png|center]]
[[Файл:Vsc_16.png|center]]
Строка 98: Строка 107:


[[Файл:Vsc_17.png|center]]
[[Файл:Vsc_17.png|center]]
===Система контроля версий GIT===
Для установки модулей и настройки авторизации в <code>GitLab</code> необходимо воспользоваться помощью программиста.

Текущая версия от 06:47, 13 мая 2026

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

Примечание

  • Для установки 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) по умолчанию предусмотрен предпросмотр (кнопка Открыть область предварительного просмотра справа в верхнем правом углу):


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

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

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

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

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

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

Расширения

Russian - Code Spell Checker

Расширение 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

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

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