Вклад
Во-первых, спасибо, что нашли время внести свой вклад. В этом руководстве используется Docusaurus для создания самого руководства и pre-commit для различных задач форматирования/очистки, таких как форматирование блоков кода Python. Обязательно установите их соответствующие CLI, так как они используются нашими скриптами npm.
Необходимые компоненты
- node версии 16.14 или новее
- pre-commit
Локальная разработка
Клонируйте репозиторий в нужную вам папку и перейдите в него с помощь cd.
git clone https://github.com/disnake-ru/guide.git
cd guide/guide
Далее установите зависимости с помощью npm install.
Запуск сервера
Чтобы создать и предоставить предварительный просмотр вашего сайта локально, выполните следующие команды, находясь в корневом каталоге:
cd guide
npm run start
Это позволит обслуживать сайт на http://localhost:3000/. Чтобы указать порт сервера разработки, вы можете использовать опцию --port.
npm run start -- --port=8000
Линтинг
Внесение изменений/дополнений имеет решающее значение для обеспечения согласованности материала с остальной частью руководства.