i18n Replacer

A small javascript utility for adding i18n tags to html, and creating translation.json files based on i18n tags.

Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

An html parser to add data-i18n tags to Roll20 character sheet code. Also creates translation.json objects based on provided data-i18n keys.

(back to top)

Built With

• JS

(back to top)

Getting Started

Install the package using npm:

npm i i18nreplacer

Then add the replacer to your script

const replacer = require('i18nreplacer');

// Get html text as normal in your script

const myFunc = (html) => {
  const translated = replacer.apply18n(html);
  const translationJSON = replacer.translate(translated);
  // Do what you want with the translated html/translation.json
}

Prerequisites

Node, NPM

(back to top)

Usage

Use to create a translation workflow for your character sheet project. Used in the K-scaffold and Kscaffold Initializer packages.

(back to top)

Roadmap

No upgrades planned See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated. If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the mit License. See LICENSE.txt for more information.

(back to top)

Contact

Scott Casey - @Kurohyoustudios - scaseydv@gmail.com

Project Link: https://github.com/Kurohyou-Studios/i18nReplacer

(back to top)

Acknowledgments

This readme template adapted from the Best-README-Template by Othneil Drew. Readme generated by Genme! by Scott Casey.

(back to top)