Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/angeloocana/gatsby-plugin-i18n
Multi language routes for Gatsby
https://github.com/angeloocana/gatsby-plugin-i18n
Last synced: 3 days ago
JSON representation
Multi language routes for Gatsby
- Host: GitHub
- URL: https://github.com/angeloocana/gatsby-plugin-i18n
- Owner: angeloocana
- Created: 2017-08-27T00:11:49.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2023-01-05T06:15:08.000Z (almost 2 years ago)
- Last Synced: 2024-11-02T01:32:10.479Z (14 days ago)
- Language: JavaScript
- Homepage:
- Size: 3.32 MB
- Stars: 435
- Watchers: 7
- Forks: 77
- Open Issues: 136
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-list - gatsby-plugin-i18n
README
# gatsby-plugin-i18n
[](https://www.codacy.com/app/angeloocana/gatsby-plugin-i18n?utm_source=github.com&utm_medium=referral&utm_content=angeloocana/gatsby-plugin-i18n&utm_campaign=badger)
[](https://travis-ci.org/angeloocana/gatsby-plugin-i18n)
[](https://www.npmjs.com/package/gatsby-plugin-i18n)
[](http://codecov.io/github/angeloocana/gatsby-plugin-i18n)
[](https://gemnasium.com/angeloocana/gatsby-plugin-i18n)
[](http://opensource.org/licenses/MIT)
Hi Folks!
Are you trying to build a multi language gatsby website?
We want to help you! Please open an issue for help, suggestions or bugs.
You can use this plugin with **react-intl**, **i18next**, or any other i18n library. This plugin do not translate messages, it just creates routes for each language, and you can use different layouts for each language if you want to.
## How it works
Name your files with .**langKey**.js and the url will be /**langKey**/path/fileName
Examples:
file | url
-- | --
src/pages/about.**en**.js | /**en**/about
src/pages/about/index.**en**.js | /**en**/about
src/pages/blog/gatsby-i18n.**pt**.md | /**pt**/blog/gatsby-i18n
## Why?
Google! Google needs different URLs to crawl and render your pages for each language.
## Showcase
Websites built with Gatsby i18n:
* [hugomagalhaes.com](https://www.hugomagalhaes.com) [(source)](https://github.com/hugomn/hugomagalhaes.com) *Gatsby v2*
* [angeloocana.com](https://angeloocana.com) [(source)](https://github.com/angeloocana/angeloocana)
* [tic-tac-toe-ai.surge.sh](https://tic-tac-toe-ai.surge.sh) [(source)](https://github.com/angeloocana/tic-tac-toe-ai)
* [Imagine Clarity](https://imagineclarity.com)
* [Peintagone](https://www.peintagone.be)
Feel free to add your project to the list, we would love to see what you are building!
## Starters
[Docs](https://www.gatsbyjs.org/docs/gatsby-starters/)
* [gatsby-starter-default-i18n](https://github.com/angeloocana/gatsby-plugin-i18n/tree/master/packages/gatsby-starter-default-i18n) [DEMO](https://gatsby-starter-default-i18n.netlify.com), features:
- automatic browser-language detection and redirection
- integration with react-intl `FormattedMessage` with translation keys
- custom layout and pages per language
- language switcher component
- dev mode with HMR
- build deployed to Netlify
## Packages
* [gatsby-plugin-i18n](https://github.com/angeloocana/gatsby-plugin-i18n/tree/master/packages/gatsby-plugin-i18n)
* [gatsby-plugin-i18n-readnext](https://github.com/angeloocana/gatsby-plugin-i18n/tree/master/packages/gatsby-plugin-i18n-readnext)
* [gatsby-plugin-i18n-tags](https://github.com/angeloocana/gatsby-plugin-i18n/tree/master/packages/gatsby-plugin-i18n-tags)
* [ptz-i18n](https://github.com/angeloocana/gatsby-plugin-i18n/tree/master/packages/ptz-i18n)
## Install
```bash
yarn add gatsby-plugin-i18n
```
## How to use
Include the plugin in your `gatsby-config.js` file.
### Simple configuration example:
```javascript
// Add to gatsby-config.js
plugins: [
{
resolve: 'gatsby-plugin-i18n',
options: {
langKeyDefault: 'en',
useLangKeyLayout: false
}
}
]
```
### Blog using **markdownRemark** configuration example:
```javascript
// Add to gatsby-config.js
plugins: [
{
resolve: 'gatsby-plugin-i18n',
options: {
langKeyDefault: 'en',
useLangKeyLayout: false,
markdownRemark: {
postPage: 'src/templates/blog-post.js',
query: `
{
allMarkdownRemark {
edges {
node {
fields {
slug,
langKey
}
}
}
}
}
`
}
}
}
]
```
### All Options
* **langKeyDefault:**
langKey to use when no langKey specified.
* **useLangKeyLayout:**
**true**: use a different layout for each langKey (src/layouts/**en**.js, src/layouts/**pt**.js, ...)
**false**: use default layout (src/layouts/index.js)
* **markdownRemark:**
Add markdownRemark if you are using **gatsby-transformer-remark**.
You can set a **postPage** component and a **query** to get the pages.
* **langKeyForNull:**
langKey added to page context and graphql when no langKey specified. Default: **any**.
* **pagesPaths:**
If you are not using just `/src/pages/` folder, you can add an array with the folders your are using:
```
plugins: [
//... other plugins
{
resolve: 'gatsby-plugin-i18n',
options: {
//.. other options
pagesPaths: [ '/my/custom/pages/folder1', /my/custom/pages/folder2/ ]
}
}
]
```
* **prefixDefault:**
**true**: add langKey on all pages, including default
**false**: omit langKey in url when page lang is the default.
Ex: when `langKeyDefault` is `en`, `blog/first-post.en.md` and `blog/first-post.pt.md` will have the following urls:
- `/blog/first-post`
- `/pt/blog/first-post`
Default: **true**
## Finally
Go Gatsby!
Go Open-source!
Good luck folks! Open an issue if you need help.