Дока — это добрая энциклопедия для веб-разработчиков. Наша цель — сделать документацию по веб-разработке практичной, понятной и не унылой.
Присоединяйтесь к нашему сообществу в Телеграм, чтобы быть в курсе последних новостей, или к чату, чтобы пообщаться, задать вопрос и просто хорошо провести время.
Этот репозиторий содержит платформу для сайта «Дока». Платформа собирает статьи из отдельного репозитория.
Сайт «Доки» работает на базе Eleventy. При помощи Nunjucks-темплейтов Eleventy превращает статьи в формате Markdown в HTML-страницы.
Проект собирается с помощью GitHub Actions и хостится на сервере, читайте подробнее про деплой.
Для работы с платформой вам потребуется Node.js и npm.
Чтобы запустить Доку локально, нужно:
- Скачать репозиторий.
- Сделать копию файла
.env.exampleи назвать его.env. Задать в нём нужные переменные окружения. - Установить зависимости командой
npm i. - Запустить локальный веб-сервер командой
npm start.
Больше вариантов локального запуска Доки — в руководстве по запуску.
Процесс, стиль кода и коммитов, проверки перед пулреквестом — в руководстве для контрибьюторов. Если вы работаете над кодом через ИИ-агентов, им нужен AGENTS.md.
Код распространяется по лицензии MIT, шрифты имеют собственные лицензии, подробнее читайте в документации.
Мы используем Jest.
Добавьте свои тесты. Для этого добавьте файлы тестов в папку __tests__. Файл с тестом лучше называть также, как файл, который тестируется.
Запустите тесты командой npm test.
Чтобы запустить тесты в watch режиме, используйте дополнительный флаг --watch: npm test -- --watch.
Запустите команду npm run debug и откройте в Chrome кладку chrome:://inspect.
Найдите нужную сессию в списке. Нажимайте inspect и запускайте отладку.
По-умолчанию отладчик сразу остановится. Чтобы добавить больше точек остановки добавьте в ваш код debugger; или найдите нужный файл и поставьте точку прямо в интерфейсе отладчика.