Nuxt.js Documentation

This is where the documentation is stored and served as an API

Developing

⚠️ You must at least use node >= 8.0.0 (supports async/await) to start the server.

⚠️ You must also have the main nuxtjs.org website repo up and running on localhost to be able to run the docs...

Start a dev server on localhost:4000:

npm install
npm run dev

Then access the docs via the website running on http://nuxt:3000 (see instructions on nuxtjs.org repo).

On Translations

Russian

Russian translation is maintained by Translation Gang.

Translation Repo - /translation-gang/ru.docs.nuxtjs
Primary maintainer - Grigoriy Beziuk
Primary translator - Nicholas Shachmatov

Chinese

Chinese translation is maintained by AOTU Labs from China, Shenzhen.

Translation Repo - /o2team/i18n-cn-nuxtjs-docs
Primary maintainer - AOTU Labs
Primary translator - Levin Wong, Edward Chu

Japanese

Japanese translation is maintained by Vue.js Japan User Group.

Translation Repo - https://github.com/vuejs-jp/ja.docs.nuxtjs
Primary maintainer - INOUE Takuya(@inouetakuya), HANATANI Takuma(@potato4d), numa(@aytdm)
Primary translator - INOUE Takuya(@inouetakuya), HANATANI Takuma(@potato4d), numa(@aytdm)

textlint

Japanese translation use textlint.

Example commands:

yarn textlint:ja
yarn textlint:ja:fix --dry-run
yarn textlint:ja:fix

Korean

Korean translation is maintained by Taewoong La.

Translation Repo - /DiyLecko/ko.docs.nuxtjs
Primary maintainer - Taewoong La
Primary translator - june, wanybae, rellario

French

French translation is maintained by Vuejs-FR Team.

Translation Repo - /vuejs-fr/nuxt
Primary maintainer - Bruno Lesieur (Orchard ID)
Primary translator - Julien Grünhagel (laruche)

Indonesian

Indonesian translation is maintained by Nuxt.js Indonesian Community Team.

Translation Repo - https://gitlocalize.com/repo/100/id
Primary maintainer - Achan
Primary translator - afrianjunior, fikrizufri, huiralb, jefrydco, muhibbudins, nusendra, perjakasunda, tapitapeh, wahwahid

Want to help with the translation?

Much of the translation was done using a tool called GitLocalize, which is unfortunately reaching its end of service soon. Hence, we're currently exploring and open to suggestions on how to keep this process as streamlined as possible.

For now, always check the en/ version of a document for its latest revision before starting a translation.

tell-k / docs