#117 part 1: New documentation website (#151)

This commit concerns the first subtask of this issue: https://github.com/JohnXLivingston/peertube-plugin-livechat/issues/117

It provide a brand new documentation website, that replace the previous markdown files.
The website is auto-generated using CI/CD, and can be found here: https://johnxlivingston.github.io/peertube-plugin-livechat/
This commit is contained in:
John Livingston
2023-02-13 17:58:06 +01:00
committed by GitHub
parent dc1de61a95
commit e17257a90f
114 changed files with 2302 additions and 990 deletions

View File

@ -0,0 +1,10 @@
+++
title="Translate"
description="Translate the plugin"
weight=20
chapter=false
+++
{{% notice warning %}}
This page is not yet translated in your language, please refer to the english version. You can switch to it by using the language selector in the left menu.
{{% /notice %}}

View File

@ -0,0 +1,21 @@
+++
title="Translate"
description="Translate the plugin"
weight=20
chapter=false
+++
You can help us to translate this PeerTube plugin by creating or modifying translation files in the `languages` folder.
Please work on the `develop` branch, and do your commits and pull request on this branch.
If the language you are interesting in does not exist yet, create a file `code.json` in the `languages` folder, where `code` is the language code.
The language code must be the same as the Peertube's langage code (see [Peertube documentation](https://github.com/Chocobozzz/PeerTube/blob/develop/support/doc/translation.md)).
Then add the language file in the `package.json` file, under the key `translations`.
Translation strings are set in the language file as follow:
- files are in [JSON format](https://www.json.org)
- the JSON key is the english string (see existing keys in the [french translation file](languages/fr.json)).
- the JSON value is the translating string
- NB: there is no english translation file (this is how translation works for peertube's plugins)

View File

@ -0,0 +1,21 @@
+++
title="Traduction"
description="Traduire le plugin"
weight=20
chapter=false
+++
Vous pouvez nous aider à traduire ce plugin Peertube en créant ou modifiant des fichiers de traduction dans le dossier `languages`.
Merci de travailler sur la branche `develop`, et de faire vos _pull request_ sur cette branche.
Si la langue dans laquelle vous souhaitez traduire n'existe pas encore, créez un fichier `code.json` dans le dossier `languages`, où `code` est le code langue.
Le code langue doit être dans le même format que les codes langues de Peertube (voir la [documentation Peertube](https://github.com/Chocobozzz/PeerTube/blob/develop/support/doc/translation.md)).
Ensuite, ajoutez le fichier de langue dans le fichier `package.json`, sous la clé `translations`.
Les traductions sont sous la forme suivante dans le fichier de langue :
- les fichiers sont au [format JSON](https://www.json.org)
- les clés JSON sont le texte en anglais (voir les clés existantes dans [le fichier de traduction français](languages/fr.json), qui fait référence)
- la valeur JSON est la traduction
- NB: il n'y a pas de fichier de traduction pour l'anglais (c'est la façon de fonctionner de Peertube)

View File

@ -0,0 +1,10 @@
+++
title="Translate"
description="Translate the plugin"
weight=20
chapter=false
+++
{{% notice warning %}}
This page is not yet translated in your language, please refer to the english version. You can switch to it by using the language selector in the left menu.
{{% /notice %}}