Skip to content

Платформа Доки: шаблоны, стили, скрипты и всё для сборки сайта

License

Notifications You must be signed in to change notification settings

doka-guide/platform

Folders and files

NameName
Last commit message
Last commit date

Latest commit

solarrustskorobaeusigsekor
Oct 30, 2023
00656a4 · Oct 30, 2023
Jun 30, 2023
Jan 26, 2023
Feb 28, 2023
Oct 30, 2023
Feb 4, 2023
Nov 8, 2021
Feb 9, 2021
May 11, 2023
Jul 15, 2021
Mar 30, 2023
Oct 20, 2022
Dec 23, 2022
Oct 27, 2022
May 1, 2021
Oct 30, 2021
Feb 5, 2022
Apr 6, 2022
Nov 14, 2022
Mar 13, 2022
Jun 13, 2021
Sep 18, 2023
Mar 27, 2023
Feb 4, 2023
Dec 23, 2022
May 1, 2022
May 11, 2023
May 11, 2023

Repository files navigation

Платформа Доки

Статус линтера W3C Validator Статус деплоя Статус Docker Дискорд

⚠️ Если сайт Доки медленно загружается или не работает совсем

Дока — это добрая энциклопедия для веб-разработчиков. Наша цель — сделать документацию по веб-разработке практичной, понятной и не унылой.

Вся актуальная информация по Доке обсуждается в нашем сообществе в Дискорде.

Этот репозиторий содержит платформу для сайта «Дока». Платформа собирает статьи из отдельного репозитория.

Как устроен сайт

Сайт «Доки» работает на базе Eleventy. При помощи Nunjucks-темплейтов Eleventy превращает статьи в формате Markdown в HTML-страницы.

Проект собирается с помощью GitHub Actions и хостится на сервере, читайте подробнее про деплой.

Как работать

Для работы с платформой вам потребуется Node.js и npm.

Чтобы запустить Доку локально, нужно:

  1. Скачать репозиторий.
  2. Сделать копию файла .env.example и назвать его .env. Задать в нём нужные переменные окружения.
  3. Установить зависимости командой npm i.
  4. Запустить локальный веб-сервер командой npm start.

Больше вариантов локального запуска Доки — в руководстве по запуску.


Код распространяется по лицензии MIT, шрифты имеют собственные лицензии, подробнее читайте в документации.

Как запускать тесты

Мы используем Jest. Добавьте свои тесты. Для этого добавьте файлы тестов в папку __tests__. Файл с тестом лучше называть также, как файл, который тестируется.

Запустите тесты командой npm test. Чтобы запустить тесты в watch режиме, используйте дополнительный флаг --watch: npm test -- --watch.

Как дебажить?

Запустите команду npm run debug и откройте в Chrome кладку chrome:://inspect.

Найдите нужную сессию в списке. Нажимайте inspect и запускайте отладку.

По-умолчанию отладчик сразу остановится. Чтобы добавить больше точек остановки добавьте в ваш код debugger; или найдите нужный файл и поставьте точку прямо в интерфейсе отладчика.