Vuetify Documentation

This is the repository for the Vuetify documentation.

Project Install

git clone https://github.com/vuetifyjs/vuetifyjs.com.git
yarn
yarn dev

Running with local Vuetify

Run Vuetify

git clone https://github.com/vuetifyjs/vuetify.git
yarn
yarn link
yarn watch

Link Vuetify to docs

git clone https://github.com/vuetifyjs/vuetifyjs.com.git
yarn
yarn link vuetify
yarn dev

Want to help with the translation?

If you feel ambitious with translating the documentation, you can fork the repo, create a "work-in-progress" issue to inform others that you're doing the translation, and go for it.

If you are looking to get more feedback before beginning, let us know that you want to help translate the documentation in the community discord in the #i18n channel and would like feedback.

We greatly appreciate help from the community with this :)

How to contribute

Punctual problems in translations, such as spelling errors or confusing phrases, can be reported by sending issues in this repository. Make it clear which page the problem is referring to, and preferably offer a suggestion to improve clarity.

If you feel comfortable translating/reviewing content on your own, the steps are:

• Make an fork of this repo to your own account;
• Create an issue in this repo, of type work-in-progress, to inform what you are doing;
• If you want to add a new language, copy and follow the en translation structure;
• Translate/revise the files that you choose;
• When finished, make a pull request with the commit description in English;
• All PRs should be made to the dev branch;
• Do not forget to pull the latest changes before resuming the process.

If you can not completely finish a file translation, but want to send the partial work, make it clear in the issue of your work after the submission, to report what issues persist in the uploaded file. In this case, you must include untranslated component files and variables in your commit.

Translation structure

• Make sure the language you are working is listed at:
  • i18n/languages.js;
  • lang/index.js;
• Existing translations can be found in the lang folder;
• Follow the en translation structure;
• Keep the component files even if you don't translate them.