alexeyvokin / docs-ru

📄 Документация для Vue 3

Документация для Vue 3 на русском

Вклад в развитие

Сайт построен на VitePress и основывается на @vue/theme. Содержимое сайта написано в формате Markdown и расположено в src. Простые изменения можно вносить напрямую в файл на GitHub и создавать из его интерфейса пулл-реквест.

Для локальной разработки предпочтительный менеджер пакетов pnpm:

pnpm i
pnpm run dev

Для проекта требуется Node.js версии v14.0.0 или выше, потому что используются новые возможности JavaScript в коде, например опциональная цепочка.

Работа над переводом

• До переезда на VitePress уже была документация для Vue 3 на русском языке
• Те кто хочет помочь, но с переводом может быть сложно — можно помогать поиском одинаковых абзацев в переведённой (см. ссылку выше) документации, скорее всего будут такие же где-то на страницах новой документации.
• Те кто хочет помочь, но только изучает Vue, всегда можно вычитать уже переведённый раздел на предмет опечаток, ошибок, неправильных окончаний слов
• Те кто хочет помочь и может переводить, также можно облегчить жизнь подсматривая в переводчик Deepl
• При переводе сохраняйте якоря оригинальных заголовков

- ## Original Header
+ ## Переведенный заголовок {#original-header}

• Чтобы не начать переводить файл, который кто-то уже переводит, создавайте Issue с указанием пути к файлу
• Если файл слишком большой или больше нет времени его закончить создавайте PR с тем что успели :)
• Если захочется что-то обсудить, в репозитории открыты Discussions. Также есть отдельный телеграм чат

Работа над содержанием

• См. документацию VitePress о поддерживаемых расширениях Markdown и возможностями по использованию синтаксиса Vue внутри markdown.

• См. Руководство по написанию, где собраны правила и рекомендации по написанию и поддержке документации.

Работа над темой

Если потребуется внести изменения в тему, обратитесь к инструкциям по разработки тем.