VSinerva/freesewing
1
0
Fork 0
Code Activity
freesewing/markdown/dev/reference/plugins/i18n/en.md

63 lines
1.9 KiB
Markdown
Raw Normal View History

chore: Linting for markdown and js
2021-10-17 17:34:55 +02:00
***
## title: i18n
feat: Flat import of markdown repo This is a flat (without history) import of (some of) the content from our markdown module. We've imported this without history because the repo contains our blog posts and showcases posts content prior to porting them to strapi. Since this contains many images, it would balloon the size of this repo to import the full history. Instead, please refer to the history of the (archived) markdown repo at: https://github.com/freesewing/markdown
2021-08-25 16:09:31 +02:00
[![Run-time plugin](https://img.shields.io/badge/Type-run--time-pink.svg)](/plugins)
chore: Linting for markdown and js
2021-10-17 17:34:55 +02:00
 
feat: Flat import of markdown repo This is a flat (without history) import of (some of) the content from our markdown module. We've imported this without history because the repo contains our blog posts and showcases posts content prior to porting them to strapi. Since this contains many images, it would balloon the size of this repo to import the full history. Instead, please refer to the history of the (archived) markdown repo at: https://github.com/freesewing/markdown
2021-08-25 16:09:31 +02:00
[![License: MIT](https://img.shields.io/npm/l/@freesewing/plugin-i18n.svg?label=License)](https://www.npmjs.com/package/@freesewing/plugin-i18n)
chore: Linting for markdown and js
2021-10-17 17:34:55 +02:00
 
[![Code quality on DeepScan](https://deepscan.io/api/teams/2114/projects/2993/branches/23256/badge/grade.svg)](https://deepscan.io/dashboard#view=project\&tid=2114\&pid=2993\&bid=23256)
 
feat: Flat import of markdown repo This is a flat (without history) import of (some of) the content from our markdown module. We've imported this without history because the repo contains our blog posts and showcases posts content prior to porting them to strapi. Since this contains many images, it would balloon the size of this repo to import the full history. Instead, please refer to the history of the (archived) markdown repo at: https://github.com/freesewing/markdown
2021-08-25 16:09:31 +02:00
[![Open issues tagged pkg:plugin-i18n](https://img.shields.io/github/issues/freesewing/freesewing/pkg:plugin-i18n.svg?label=Issues)](https://github.com/freesewing/freesewing/issues?q=is%3Aissue+is%3Aopen+label%3Apkg%3Aplugin-i18n)
The **i18n** plugin provides translation for your pattern:
chore: Linting for markdown and js
2021-10-17 17:34:55 +02:00
\<Example part="path\_attr" caption="An example in English" design={false} options={{locale: 'en'}} />
\<Example part="path\_attr" caption="An example in French" design={false} options={{locale: 'fr'}} />
feat: Flat import of markdown repo This is a flat (without history) import of (some of) the content from our markdown module. We've imported this without history because the repo contains our blog posts and showcases posts content prior to porting them to strapi. Since this contains many images, it would balloon the size of this repo to import the full history. Instead, please refer to the history of the (archived) markdown repo at: https://github.com/freesewing/markdown
2021-08-25 16:09:31 +02:00
It uses the [`insertText`](/plugins#inserttext) hook to do so.
<Note>
This plugin provides the mechanism for translation, but does not come with translations itself.
For this, you can use our [i18n package](/reference/packages/i18n).
</Note>
## Installation
```bash
npm install @freesewing/plugin-i18n
```
## Usage
chore: Linting for markdown and js
2021-10-17 17:34:55 +02:00
Like all [build-time plugins](/guides/plugins/#build-time-plugins), you load them
feat: Flat import of markdown repo This is a flat (without history) import of (some of) the content from our markdown module. We've imported this without history because the repo contains our blog posts and showcases posts content prior to porting them to strapi. Since this contains many images, it would balloon the size of this repo to import the full history. Instead, please refer to the history of the (archived) markdown repo at: https://github.com/freesewing/markdown
2021-08-25 16:09:31 +02:00
by passing them to the [`freesewing.Design`](/reference/api#design) constructor:
```js
import aaron from "@freesewing/aaron";
import i18n from "@freesewing/plugin-i18n";
import translations from "@freesewing/i18n";
const pattern = new aaron()
.use(i18nPlugin, { strings: translations });
```
You should also pass a second argument which holds your translations.
It should be structured as such:
```js
{
strings:
en: {
example: "Example"
},
nl: {
example: "Voorbeeld"
},
// More languages can follow
}
}
```
Copy permalink