vuejs.org

Important: This repository is for Vue 1.x and 2.x only. Issues and pull requests related to 3.x are managed in the v3 doc repo.

This site is built with hexo. Site content is written in Markdown format located in src. Pull requests welcome!

Writing

See the Vue Docs Writing Guide for our rules and recommendations on writing and maintaining documentation.

Developing

$ npm install
$ npm start # dev server at http://localhost:4000

Deploying

The site is automatically deployed when commits land in master, via Netlify.

If you are the maintainer of a community translation fork and would like to deploy via Netlify instead of GitHub pages, please ping @yyx990803 in an issue to request a Netlify team membership and DNS update.

On Translations

Translations for this documentation project are currently maintained in separate repositories forked from this original one.

Arabic

Arabic translation is maintained by Interstellar Club

Translation Repo - /interstellarClub/ar.vuejs.org
Primary Maintainers :
- Ilyes Chouia
- Ahmed Aissaoui

French

French translation is maintained by Vuejs-FR.

Translation Repo - /vuejs-fr/vuejs.org

Italian

Translation Repo - /vuejs/it.vuejs.org

Japanese

Japanese translation is maintained by Vue.js japan user group

Translation Repo - /vuejs/jp.vuejs.org
Primary maintainer - kazupon
Secondary Maintainers:
- re-fort
- potato4d
- oohira

Korean

Korean translation is maintained by Vue.js Korean User group.

Translation Repo - /vuejs-kr/kr.vuejs.org
Primary maintainer - ChangJoo Park

Mandarin

Translation Repo - /vuejs/cn.vuejs.org

Persian (Farsi)

Persian translation is maintained by VueJS-fa.

Translation Repo - /vuejs-fa/fa.vuejs.org
Primary maintainer - Pooya Parsa

Português-Br

Português-Br translation is maintained by Vuejs-Br.

Translation Repo - /vuejs-br/br.vuejs.org

Russian

Russian translation is maintained by Translation Gang.

Translation Repo - /translation-gang/ru.vuejs.org
Primary maintainer - Grigoriy Beziuk

Spanish

Translation Repo - /1950Labs/vuejs.org
Spanish translation is maintained by:

1950Labs & Vue.js Montevideo:

Vietnamese

Vietnamese translation is maintained by Vue.js Vietnam User group.

Translation Repo: /vuejs-vn/vuejs.org
Primary maintainer - phanan

Bahasa Indonesia

Bahasa Indonesia translation is maintained by Vue.js Indonesia.

Translation Repo: /vuejs-id/docs

Want to help with the translation?

If you feel okay with translating quite alone, you can fork the repo, post a comment on the Community Translation Announcements issue page to inform others that you're doing the translation and go for it.

If you are more of a team player, Translation Gang might be for you. Let us know somehow that you're ready to join this international open-source translators community. Feel free to contact Grigoriy Beziuk or anybody else from the team.

And thank you in advance ;)

tianyang1027/vuejs.org