Дока — это добрая энциклопедия для веб-разработчиков. Наша цель — сделать документацию по веб-разработке практичной, понятной и не унылой.
Дока состоит из двух репозиториев: платформа на базе Eleventy собирает статьи из репозитория с контентом (мы сейчас в нём), и на выходе получается наш красивый сайт.
📘 Этот репозиторий содержит только тексты статей и материалов проекта «Дока»!
Дока постоянно развивается. Вы можете писать статьи, помогать с разработкой или редактированием. Вы можете всё! Прекрасный мир опенсорса 🧚♀️
Почитайте, чем можно помочь Доке.
Хотите писать для Доки? Вам поможет руководство по стилю.
Прочитали и готовы?
- Форкните репозиторий с контентом и склонируйте его к себе.
- Определитесь с форматом материала (дока или статья) и,
- если такой статьи ещё нет, откройте форк в терминале и введите
./new.sh. Когда вы ответите на несколько вопросов, останется открыть созданный файлindex.mdи начать писать. Также можно создать статью вручную по инструкции. - если статья уже есть, откройте её, и можете работать с текстом: вносить изменения, добавлять что-то полезное.
- если такой статьи ещё нет, откройте форк в терминале и введите
- Напишите статью (не забывайте сверяться с руководством по стилю). Всё, что хорошо выглядит в маркдауне, будет хорошо выглядеть на сайте. Если вы хотите предпросматривать статью локально, почитайте инструкцию по предпросмотру.
- Дополнительные материалы: картинки, демки, блок «На практике» сохраняйте в ту же папку, в подпапки images, demos, practice и так далее.
- Запустите автоматическую проверку орфографии командой
npx yaspeller --only-errors --file-extensions ".md,.html" *(вы можете отредактировать это выражение, чтобы протестировать только те файлы, которые вы меняли). - Закончили? Создайте пул-реквест. Вот и всё! После небольшой проверки ваш материал появится на сайте Доки!
Распространяется под лицензиями CC BY-NC-SA 4.0 и CC BY-NC-ND 4.0, подробнее читайте в документации.