Repository files navigation

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

Дока состоит из двух репозиториев:платформа на базеEleventy собирает статьи из репозитория с контентом (мы сейчас в нём), и на выходе получается наш красивыйсайт.

📘 Этот репозиторий содержит только тексты статей и материалов проекта «Дока»!

Дока постоянно развивается. Вы можете писать статьи, помогать с разработкой или редактированием. Вы можете всё! Прекрасный мир опенсорса 🧚‍♀️

Почитайте,чем можно помочь Доке.

Хотите писать для Доки? Вам поможетруководство по стилю.

Прочитали и готовы?

1. Форкнитерепозиторий с контентом и склонируйте его к себе.
2. Определитесь с форматом материала (дока или статья) и,
   • если такой статьи ещё нет, откройте форк в терминале и введите./new.sh. Когда вы ответите на несколько вопросов, останется открыть созданный файлindex.md и начать писать. Также можно создать статью вручнуюпо инструкции.
   • если статья уже есть, откройте её, и можете работать с текстом: вносить изменения, добавлять что-то полезное.
3. Напишите статью (не забывайте сверяться сруководством по стилю). Всё, что хорошо выглядит в маркдауне, будет хорошо выглядеть на сайте. Если вы хотите предпросматривать статью локально, почитайтеинструкцию по предпросмотру.
4. Дополнительные материалы: картинки,демки, блок «На практике» сохраняйте в ту же папку, в подпапкиimages,demos,practice и так далее.
5. Запустите автоматическую проверку орфографии командойnpx yaspeller --only-errors --file-extensions ".md,.html" * (вы можете отредактировать это выражение, чтобы протестировать только те файлы, которые вы меняли).
6. Закончили? Создайте пул-реквест. Вот и всё! После небольшой проверки ваш материал появится на сайте Доки!

Распространяется под лицензиямиCC BY-NC-SA 4.0 иCC BY-NC-ND 4.0, подробнее читайтев документации.