Необходимые инструменты

Для работы с этими документами вам не потребуется много усилий.Все, что перечислено здесь, бесплатно и работает на Windows, macOS и Linux.

Node.js

VitePress работает на узле, поэтому этот параметр не является обязательным.Загрузите сборку LTS с nodejs.org — все, начиная с Node 18, работает.

После завершения установки откройте терминал и проверьте его:

node -v
npm -v

Если оба напечатают номер версии, все в порядке.Если терминал сообщает вам, что команда не найдена, закройте ее и откройте новую.Установщик добавляет Node в ваш PATH только для терминалов, открытых после его запуска.

Git

Git — это то, что вы используете для загрузки репозитория и отправки изменений обратно.Получите его от git-scm.com.

При новой установке вы должны сообщить Git, кто вы, иначе у ваших коммитов не будет автора:

git config --global user.name "Your Name"
git config --global user.email "you@example.com"

Используйте тот же адрес электронной почты, что и вашУчетная запись GitHub или GitHub не будет подключать коммиты к вашему профилю.

Visual Studio Code

Подойдет любой текстовый редактор, но репозиторий настроен для VS Code, и в остальной части этого руководства предполагается, что вы его используете.

При первом открытии папки проекта VS Code отобразится уведомление с вопросом, хотите ли вы установить рекомендуемые расширения.Скажи да.Список находится в .vscode/extensions.json и он короткий:

Расширение	Что он делает
красивее	Форматирует Markdown, чтобы все файлы выглядели одинаково
Markdown Улучшенный предварительный просмотр	Параллельный просмотр во время ввода
Еще лучше ТОМЛ	Подсветка синтаксиса для netlify.toml
Дерево задач	Собирает все TODO: в проекте в одну панель

TIP

Включите параметр Форматировать при сохранении в настройках VS Code.Prettier будет очищать ваш Markdown каждый раз, когда вы нажимаете «Сохранить», и вам больше никогда не придется думать о пробелах.

Учетная запись GitHub

Бесплатная, и она вам понадобится, чтобы открыть запрос на включение.Зарегистрируйтесь по адресу github.com.

Если вы планируете отправлять данные со своего компьютера, а не редактировать в браузере, настройте также ключ SSH — собственное прохождение GitHub описывает это лучше, чем мы могли бы.

То, что вам не нужно

Вы пишете Markdown, а не код.Вам не нужно знать Vue, TypeScript или что-либо еще о том, как VitePress работает внутри.Если вы можете написать сообщение на форуме, вы можете создать страницу здесь.