Skip to content

Контент Доки: статьи, картинки, демки и документация для авторов

License

Unknown, Unknown licenses found

Licenses found

Unknown
LICENSE-ND.md
Unknown
LICENSE-SA.md
Notifications You must be signed in to change notification settings

doka-guide/content

Folders and files

NameName
Last commit message
Last commit date
Nov 19, 2023
Nov 23, 2023
Nov 21, 2023
Nov 15, 2023
Nov 23, 2023
Oct 14, 2023
Nov 15, 2023
Jul 6, 2023
Nov 21, 2023
Nov 21, 2023
Nov 17, 2023
Jun 25, 2023
Nov 20, 2023
Feb 9, 2021
Oct 25, 2022
Oct 30, 2021
Nov 23, 2023
Oct 31, 2023
Aug 3, 2023
Jun 13, 2021
Jun 13, 2021
Jun 25, 2023
May 3, 2023
Oct 8, 2021

Repository files navigation

Контент Доки

Статус EditorConfig Статус спеллера Статус словаря Статус проверки ссылок Статус деплоя Дискорд

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

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

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

Дока состоит из двух репозиториев: платформа на базе 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, подробнее читайте в документации.

About

Контент Доки: статьи, картинки, демки и документация для авторов

Topics

Resources

License

Unknown, Unknown licenses found

Licenses found

Unknown
LICENSE-ND.md
Unknown
LICENSE-SA.md

Stars

Watchers

Forks

Languages