Giter VIP home page Giter VIP logo

keystone-i18n's Introduction

NPM version

Very simple KeystoneJS i18n based on JSON locale files & cookies

This plugin is a simple integration for Keystone of mashable/i18n node package, an amazingly powerful i18n for node - https://www.npmjs.com/package/i18n If you are looking for a more extensive i18n configuration, check their docs!

Installation

npm install --save keystone-i18n

Usage

  1. Create directory locales and default JSON file for each locale you want to use. You can parse more advanced locale files following mashup/i18n package markup guidelines

Example JSON locale file

{
  "Hello": "Hello",
  "Hello %s": "Hello %s",
  "weekend": "weekend",
  "Hello %s, how are you today? How was your %s.": "Hello %s, how are you today? How was your %s.",
  "Hi": "Hi",
  "Howdy": "Howdy",
  "%s cat": {
    "one": "%s cat",
    "other": "%s cats"
  },
  "cat": {
    "one": "%s cat",
    "other": "%s cats"
  }
}
  1. Load the plugin module
// Require keystone-i18n
var keystonei18n = require('keystone-i18n');
  1. Initialize keystone-i18n right before keystone app - default options are shown below
// Initialize Keystone i18n before starting keystone
keystonei18n.init({
    locales: ['en', 'es'],
    directory: __dirname + '/locales',
    defaultLocale: 'en',
    cookie: 'language'
});

// Start Keystone to connect to your database and initialise the web server
keystone.start();
  1. Basic syntax - Use __() to translate a single phrase and add it to locales files if unknown. Returns translated parsed and substituted string.
// template and global (this.locale == 'es') 
__('Hello'); // Hola 
__('Hello %s', 'Andrea'); // Hola Andrea
  1. Or use it into templates
//- Jade
h1 #{__('Hello')}
//- Twig
<h1>{{ __('Hello') }}</h1>
  1. Add to routes new controller
app.get('/lang/:lang', keystonei18n.switchLocale)

License

GNU General Public License

Author

Raul Huelamo - http://huelamo.info - [email protected]

TODO

  • Check Nunjucks / Handlebars compatibility
  • Generate locale files from Keystone CMS

keystone-i18n's People

Contributors

raulhuelamo avatar scipe avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.