https://github.com/nuxt-community/nuxt-i18n

I18n module for Nuxt
https://github.com/nuxt-community/nuxt-i18n

i18n javascript nuxt nuxt-module routing vue

Last synced: about 2 months ago
JSON representation

I18n module for Nuxt

• Host: GitHub
• URL: https://github.com/nuxt-community/nuxt-i18n
• Owner: nuxt-modules
• License: mit
• Created: 2017-11-12T20:42:35.000Z (almost 7 years ago)
• Default Branch: main
• Last Pushed: 2024-05-01T11:02:44.000Z (5 months ago)
• Last Synced: 2024-05-01T16:49:15.751Z (5 months ago)
• Topics: i18n, javascript, nuxt, nuxt-module, routing, vue
• Language: TypeScript
• Homepage: https://i18n.nuxtjs.org
• Size: 19.5 MB
• Stars: 1,623
• Watchers: 27
• Forks: 462
• Open Issues: 163
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Nuxt i18n](./docs/public/cover.png)](https://i18n.nuxtjs.org)

[![](https://img.shields.io/npm/v/%40nuxtjs%2Fi18n/latest.svg?style=flat-square)](https://npmjs.com/package/%40nuxtjs%2Fi18n)

[![](https://img.shields.io/npm/v/%40nuxtjs%2Fi18n/latest.svg?style=flat-square)](https://npmjs.com/package/%40nuxtjs%2Fi18n)

[![](https://img.shields.io/npm/dt/%40nuxtjs%2Fi18n.svg?style=flat-square)](https://npmjs.com/package/%40nuxtjs%2Fi18n)

[![](https://snyk.io/test/github/nuxt-community/i18n-module/badge.svg?style=flat-square)](https://snyk.io/test/github/nuxt-modules/i18n)



# Nuxt I18n

> I18n module for Nuxt

The i18n module for Nuxt 3

## ✅ Status: v8

If you would like to use the stable version for Nuxt 2, please see the [`v7` branch](https://github.com/nuxt-modules/i18n/tree/v7)

## 🚀 Usage

### Install

1. Add the following line to the `devDependencies` with your package manager:

```sh

npx nuxi@latest module add i18n

```

2. Add `@nuxtjs/i18n` to the `modules` section of `nuxt.config.ts`

```ts

{

  modules: [

    '@nuxtjs/i18n',

  ],

}

```

## Edge Release Channel

We provide [the Edge Release Channel nuxt i18n module, like Nuxt3](https://nuxt.com/docs/guide/going-further/edge-channel#edge-release-channel)

Nuxt i18n module is undergoing commits, improvements and bug fixes. You can opt-in to be the first to test it before the next release.

### Opting Into the Edge Channel

Update nuxt i18n module dependency inside `package.json`:

```diff

{

  "devDependencies": {

--    "@nuxtjs/i18n": "^8.0.0"

++    "@nuxtjs/i18n": "npm:@nuxtjs/i18n-edge"

  }

}

```

Remove lockfile (`package-lock.json`, `yarn.lock`, or `pnpm-lock.yaml`) and reinstall dependencies.

### Opting Out From the Edge Channel

Update nuxt i18n module dependency inside `package.json`:

```diff

{

  "devDependencies": {

--    "@nuxtjs/i18n": "npm:@nuxtjs/i18n-edge"

++    "@nuxtjs/i18n": "^8.0.0"

  }

}

```

## 📖 Documentation

[Read more v8 documentation](https://i18n.nuxtjs.org/).

Keep in mind that not all features are currently supported yet and some things might be broken.

## 🔗 Links

- 📘 [Documentation for v8](https://i18n.nuxtjs.org/)

- 📘 [Documentation for v7](https://i18n.nuxtjs.org/docs/v7)

- 🔖 [Release notes](./CHANGELOG.md)

- 👥 [Community](https://discord.nuxtjs.org/) (`#i18n` channel)

## ©️ License

[MIT License](./LICENSE) - Copyright (c) Nuxt Community