Skip to content
This repository has been archived by the owner on Aug 11, 2022. It is now read-only.

chore: disable Crowdin integration #2071

Merged
merged 2 commits into from
Oct 6, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 0 additions & 9 deletions .github/PULL_REQUEST_TEMPLATE

This file was deleted.

16 changes: 0 additions & 16 deletions .github/config.yml

This file was deleted.

14 changes: 0 additions & 14 deletions .github/dependabot.yml

This file was deleted.

36 changes: 0 additions & 36 deletions .github/workflows/push.yml

This file was deleted.

22 changes: 0 additions & 22 deletions .github/workflows/schedule-auto-merge-crowdin-pr.yml

This file was deleted.

22 changes: 0 additions & 22 deletions .github/workflows/schedule-update-source-content.yml

This file was deleted.

161 changes: 4 additions & 157 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,159 +1,6 @@
# electron-i18n

[![Dependabot badge](https://img.shields.io/badge/Dependabot-enabled-blue.svg)](https://dependabot.com/)

> A home for Electron's translated documentation.

🇨🇳 🇧🇷 🇪🇸 🇯🇵 🇷🇺 🇫🇷 🇺🇸 🇩🇪

## Contributing

Do you speak multiple languages? We need your help!

To get started translating, visit
[crowdin.com/project/electron](https://crowdin.com/project/electron)
and log in with your GitHub account.

The following languages are currently being translated:

<!-- start language-table -->
- [日本語 (Japanese)](https://crowdin.com/project/electron/ja)
- [Español (Spanish)](https://crowdin.com/project/electron/es-ES)
- [中文 (Chinese Simplified)](https://crowdin.com/project/electron/zh-CN)
- [Français (French)](https://crowdin.com/project/electron/fr)
- [Русский (Russian)](https://crowdin.com/project/electron/ru)
- [Português (Portuguese)](https://crowdin.com/project/electron/pt-BR)
- [Deutsch (German)](https://crowdin.com/project/electron/de)
<!-- end language-table -->

## Installation

If you're just here to translate content, see above. ☝️

If you're here to _actually use_ this translated content for some purpose,
read on! This project is published to npm as a module containing all the
translated docs.

```sh
npm install electron-i18n
```

## Usage

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:

```js
const i18n = require('electron-i18n')
```

`i18n` is an object with the following keys:

- `electronLatestStableTag` is a string like `v1.7.8`
- `docs` - see [#docs](#docs)
- `locales` - see [#locales](#locales)
- `website` - see [#website](#website)
- `date` is a timestamp

### Docs

`i18n.docs` is an object with locale strings as keys:

```js
> Object.keys(i18n.docs)
[ 'en-US', 'fr-FR', 'ja-JP', 'zh-CN', '...']
```

Each locale object contains an object with doc HREFs as keys:

```js
> 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:

```js
> 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',
crowdinFileId: '123',
isTutorial: false,
isApiDoc: true,
isDevTutorial: false,
isApiStructureDoc: false,
markdown: '...',
html: '...'
}
```


### Locales

`i18n.locales` is an object with locale strings as keys:

```js
> Object.keys(i18n.locales)
[ 'en-US', 'fr-FR', 'ja-JP', 'zh-CN', '...']
```

Each locale object contains language names, country info, and translation
progress:

```js
> 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
}
}
```

### Website

`i18n.website` contains localized versions of [electron/electronjs.org/blob/master/data/locale.yml](https://github.com/electron/electronjs.org/blob/master/data/locale.yml).

It is an object with locale strings as keys:

```js
> Object.keys(i18n.locales)
[ 'en-US', 'fr-FR', 'ja-JP', 'zh-CN', '...']
```

```js
> i18n.website['fr-FR']
{
tagline: 'Développez des applications desktop multi-plateformes avec JavaScript, HTML et CSS',
nav: '...'
}
```


## License

[MIT](license)

[Crowdin]: https://crowdin.com/project/electron
**THIS PROJECT IS DEPRECATED** The i18n efforts continue happening in
[Crowdin](https://crowdin.com/projects/electron) but the sync is done directly
on
[electron/electronjs.org-new](https://github.com/electron/electronjs.org-new).