Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/phrase/i18next-phrase-in-context-editor-post-processor

Plugin for i18next that paires well with Phrase In-Context Editor
https://github.com/phrase/i18next-phrase-in-context-editor-post-processor

i10n i18n i18next i18next-postprocessor in-context internationalization localization phrase translate translation

Last synced: 3 days ago
JSON representation

Plugin for i18next that paires well with Phrase In-Context Editor

Awesome Lists containing this project

README 

        
# i18next Phrase In-Context Editor Post Processor



[![NPM version](https://img.shields.io/npm/v/i18next-phrase-in-context-editor-post-processor)](https://www.npmjs.com/package/i18next-phrase-in-context-editor-post-processor)

[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)

[![LICENSE MIT](https://img.shields.io/github/license/phrase/i18next-phrase-in-context-editor-post-processor)](https://github.com/phrase/i18next-phrase-in-context-editor-post-processor/blob/master/LICENSE)

[![GitHub documentation deployment](https://img.shields.io/github/deployments/phrase/i18next-phrase-in-context-editor-post-processor/github-pages?label=docs-deploy)](https://github.com/phrase/i18next-phrase-in-context-editor-post-processor/deployments?environment=github-pages)



**i18next Phrase In-Context Editor Post Processor** is the official library for integrating [Phrase Strings In-Context Editor](https://support.phrase.com/hc/en-us/articles/5784095916188-In-Context-Editor-Strings) with [i18next](https://www.i18next.com/).



## :scroll: Documentation



To get started, have a look at the [documentation](https://phrase.github.io/i18next-phrase-in-context-editor-post-processor/). There you will find [API docs](https://phrase.github.io/i18next-phrase-in-context-editor-post-processor/api/), [getting started guide](https://phrase.github.io/i18next-phrase-in-context-editor-post-processor/guide/), [examples](https://phrase.github.io/i18next-phrase-in-context-editor-post-processor/examples/) and much more!



## :hammer: Development



``` bash

# install deps

yarn



# build dist files

yarn build



# serve examples at localhost:8080

cd examples/basic

yarn

yarn start



# lint & fix files

yarn lint

yarn lint.fix



# run all tests

yarn test

yarn test.coverage



# serve docs at localhost:8080/i18next-phrase-in-context-editor-post-processor/

yarn docs.dev

```



## :white_check_mark: Commits & Pull Requests



We welcome anyone who wants to contribute to our codebase, so if you notice something, feel free to open a Pull Request! However, we ask that you please use the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification for your commit messages and titles when opening a Pull Request.



Example: `chore: Update README`



We have an automated version management and release process based off of this message convention, so it'd be highly appreciated if you could follow this coding guideline.



## :question: Issues, Questions, Support



Please use [GitHub issues](https://github.com/phrase/i18next-phrase-in-context-editor-post-processor/issues) to share your problem, and we will do our best to answer any questions or to support you in finding a solution!



## :memo: Changelog



Detailed changes for each release are documented in the [changelog](https://github.com/phrase/i18next-phrase-in-context-editor-post-processor/blob/master/CHANGELOG.md).



## :package: Releasing



Package is being released automatically with the use of [Semantic Release Action](https://github.com/marketplace/actions/action-for-semantic-release). Just push a commit to the master and a new version will be released right away!



## :copyright: License



[MIT](http://opensource.org/licenses/MIT)