Руководство по внесению изменений

Установка Node.js и npm

Чтобы внести изменения в проект Remnawave Reverse-proxy, вам необходимо установить Node.js и npm на вашу систему. Вы можете скачать и установить их с официального сайта Node.js.

Установка git

Если вы еще не установили git на свою систему, вы можете найти инструкции по установке на официальном сайте git и страницу загрузок git-scm.com.

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

Чтобы начать, клонируйте репозиторий Remnawave Reverse-proxy на вашу локальную машину.

Склонируйте репозиторий
Окно терминала
```
git clone https://github.com/eGamesAPI/remnawave-reverse-proxy
```
Перейдите в директорию проекта
Окно терминала
```
cd remnawave-reverse-proxy/docs
```

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

Перед тем как вы сможете собрать документацию, вам необходимо установить необходимые зависимости. Выполните следующую команду в директории docs.
Окно терминала
```
npm install
```
Чтобы собрать документацию локально, выполните следующую команду.
Окно терминала
```
npm run dev
```

Это запустит локальный сервер разработки, и вы сможете просмотреть документацию по адресу http://localhost:4321.

✨ Документация, включенная в Starlight

🚀 Структура проекта

Внутри вашего проекта Astro + Starlight вы увидите следующие папки и файлы:

Директорияdocs корневая директория документации
- Директорияpublic/
  - …
- Директорияsrc
  - Директорияassets/
    Директорияen/
    …
    Директорияru/
    …
  - Директорияcomponents/
    …
  - Директорияcontent/docs корневая (en) директория документации
    index.mdx
    Директорияru/ i18n файлы
    index.mdx
  - Директорияstyles/
    …
  - content.config.ts
astro.config.mjs
package.json
tsconfig.json

Starlight ищет файлы .md или .mdx в директории src/content/docs/. Каждый файл доступен как маршрут на основе его имени.

Изображения можно добавлять в src/assets/ и встраивать в Markdown с помощью относительной ссылки.

Статические ресурсы, такие как фавиконы, можно разместить в директории public/.

🧞 Команды

Все команды выполняются из корневой директории проекта, из терминала:

Команда	Действие
`npm install`	Устанавливает зависимости
`npm run dev`	Запускает локальный сервер разработки на `localhost:4321`
`npm run build`	Собирает ваш производственный сайт в `./dist/`
`npm run preview`	Предварительный просмотр вашей сборки локально, перед развертыванием
`npm run astro ...`	Выполняет команды CLI, такие как `astro add`, `astro check`
`npm run astro -- --help`	Получить помощь по использованию Astro CLI

👀 Хотите узнать больше?

Посмотрите документацию Starlight, прочитайте документацию Astro или присоединяйтесь к серверу Discord Astro.

Перейти в документацию