A home for Electron's translated documentation.
๐จ๐ณ ๐น๐ผ ๐ง๐ท ๐ช๐ธ ๐ฐ๐ท ๐ฏ๐ต ๐ท๐บ ๐ซ๐ท ๐น๐ญ ๐ณ๐ฑ ๐น๐ท ๐ฎ๐ฉ ๐บ๐ฆ ๐จ๐ฟ ๐ฎ๐น
Do you speak multiple languages? We need your help!
See contributing.md for info on how to participate.
If you're just here to translate content, see contributing.md If you're here to use this translated content for some purpose, read on! This project is published to npm as a module containing all the translated docs.
npm install electron-i18n
The electron-i18n
module has no dependencies and exports no functions. It is
simply a large JSON object containing all of Electron's API docs and tutorial
content, in every language.
Require the module in your code:
const i18n = require('electron-i18n')
i18n
is an object with the following keys:
electronLatestStableVersion
is a string like1.7.8
electronLatestStableTag
is a string likev1.7.8
docs
- see #docslocales
- see #locales
i18n.docs
is an object with locale strings as keys:
Object.keys(i18n.docs)
[ 'en-US', 'fr-FR', 'vi-VN', 'ja-JP', 'zh-CN', '...']
Each locale object contains an object with doc HREFs as keys:
> Object.keys(i18n.docs['en-US'])
[
'/docs/tutorial/about',
'/docs/api/accelerator',
'/docs/tutorial/accessibility',
'/docs/api/app',
'...'
]
Each doc object contains metadata and an HTML version of itself, ready to be rendered:
i18n.docs['en-US']['/docs/api/app']
{
locale: 'en-US',
slug: 'app',
category: 'api',
categoryFancy: 'API',
href: '/docs/api/app',
title: 'app',
description: '\nControl your application\'s event lifecycle.\n'
githubUrl: 'https://github.com/electron/electron/tree/master/docs/api/app.md',
isTutorial: false,
isApiDoc: true,
isDevTutorial: false,
isApiStructureDoc: false,
markdown: '...',
html: '...'
}
i18n.locales
is an object with locale strings as keys:
Object.keys(i18n.locales)
[ 'en-US', 'fr-FR', 'vi-VN', 'ja-JP', 'zh-CN', '...']
Each locale object contains language names, country info, and translation progress:
i18n.locales['en-US']
{ locale: 'en-US',
languageCode: 'en',
languageName: 'English',
languageNativeName: 'English',
countryCode: 'US',
countryName: 'United States',
stats: {
translated_progress: 100,
approved_progress: 100
}
}