website: add docs to website (#2080)
* website: add fontmatter & improve image URLs where necessary * website: add docs to website * website: add prismjs for code highlighting * website: change npm install position in web.sh * website: fix an image URL in lang/cs/README.md * website: improve image paths in lang/cs/translations.md * website: add responsiveness & improve stylings of docs * website: add dir to navbar in blog & docs * website: remove scroll in mobile dropdown menu * website: remove rfcs & add guide docs to website * website: remove file renaming script from web.sh * website: add menu to docs in nav * website: add hash list & add scroll to headers * website: customize docs frontmatter through JS * website: remove supported_languages.json * website: move merge_translations.js to JS folder * website: add the following changes to docs - add frontmatter to new doc merged from master - add ignoreForWeb property to frontmatter of README.md docs * website: remove package-lock.json from .gitignore * website: add package-lock.json from .gitignore * website: add no docs message to docs dropdown * website: improve the sidebar of docs * website: add revision date to docs * website: add script to add version to docs frontmatter * website: add layout to display message in docs if its version is old * website: improve nav responsiveness * website: remove frontmatter form main README & rfcs * website: remove rfcs from website folder * website: add ignore condition for rfcs in .eleventy * website: remove frontmatter from lang README docs * website: remove README from website's lang docs * website: add guides menu in nav * website: following changes - add docs_dropdown.json - extend reference menu in nav - remove docs menu from nav * website: fix in docs sidebar * website: revert main docs README.md files * website: revert main docs README.md files * website: move scripts out of js that are for build * website: remove displayAt form guide docs * website: create a docs_sidebar.json & shift to that approach * update navigation * website: set navbar * website: add icons to external links * website: change the approach for docs sidebar creation * website: update docs template * website: add some strings to en.json and map them accordingly * remove icon --------- Co-authored-by: Evgeny Poberezkin <2769109+epoberezkin@users.noreply.github.com>
This commit is contained in:
@@ -1,3 +1,8 @@
|
||||
---
|
||||
title: Accessing files in Android app
|
||||
revision: 07.02.2023
|
||||
---
|
||||
|
||||
| 07.02.2023 | EN, [CZ](/docs/lang/cs/ANDROID.md), [FR](/docs/lang/fr/ANDROID.md) |
|
||||
|
||||
# Accessing files in Android app
|
||||
|
||||
@@ -1,3 +1,8 @@
|
||||
---
|
||||
title: Terminal CLI
|
||||
revision: 31.01.2023
|
||||
---
|
||||
|
||||
| Updated 31.01.2023 | Languages: EN, [FR](/docs/lang/fr/CLI.md), [CZ](/docs/lang/cs/CLI.md) |
|
||||
|
||||
# SimpleX Chat terminal (console) app for Linux/MacOS/Windows
|
||||
|
||||
@@ -1,3 +1,8 @@
|
||||
---
|
||||
title: Contributing guide
|
||||
revision: 31.01.2023
|
||||
---
|
||||
|
||||
| Updated 31.01.2023 | Languages: EN, [FR](/docs/lang/fr/CONTRIBUTING.md), [CZ](/docs/lang/cs/CONTRIBUTING.md) |
|
||||
|
||||
# Contributing guide
|
||||
|
||||
@@ -1,3 +1,8 @@
|
||||
---
|
||||
title: Hosting your own SMP Server
|
||||
revision: 31.01.2023
|
||||
---
|
||||
|
||||
| Updated 31.01.2023 | Languages: EN, [FR](/docs/lang/fr/SERVER.md), [CZ](/docs/lang/cs/SERVER.md) |
|
||||
|
||||
# Hosting your own SMP Server
|
||||
|
||||
@@ -1,3 +1,8 @@
|
||||
---
|
||||
title: SimpleX platform
|
||||
revision: 07.02.2023
|
||||
---
|
||||
|
||||
| Updated 07.02.2023 | Languages: EN, [FR](/docs/lang/fr/SIMPLEX.md), [CZ](/docs/lang/cs/SIMPLEX.md) |
|
||||
# SimpleX platform - motivation and comparison
|
||||
|
||||
|
||||
@@ -1,3 +1,8 @@
|
||||
---
|
||||
title: Accessing messages in the database
|
||||
revision: 31.01.2023
|
||||
---
|
||||
|
||||
| Updated 31.01.2023 | Languages: EN, [FR](/docs/lang/fr/SQL.md), [CZ](/docs/lang/cs/SQL.md) |
|
||||
|
||||
# Accessing messages in the database
|
||||
|
||||
@@ -1,3 +1,8 @@
|
||||
---
|
||||
title: Contributing translations to SimpleX Chat
|
||||
revision: 19.03.2023
|
||||
---
|
||||
|
||||
| 19.03.2023 | EN, [CZ](/docs/lang/cs/TRANSLATIONS.md), [FR](/docs/lang/fr/TRANSLATIONS.md) |
|
||||
|
||||
# Contributing translations to SimpleX Chat
|
||||
|
||||
@@ -1,3 +1,8 @@
|
||||
---
|
||||
title: Using custom WebRTC ICE servers in SimpleX Chat
|
||||
revision: 31.01.2023
|
||||
---
|
||||
|
||||
| Updated 31.01.2023 | Languages: EN, [FR](/docs/lang/fr/WEBRTC.md), [CZ](/docs/lang/cs/WEBRTC.md) |
|
||||
|
||||
# Using custom WebRTC ICE servers in SimpleX Chat
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
title: Hosting your own XFTP Server
|
||||
revision: 21.04.2023
|
||||
---
|
||||
# Hosting your own XFTP Server
|
||||
|
||||
## Overview
|
||||
|
||||
@@ -1,3 +1,6 @@
|
||||
---
|
||||
title: Quick start
|
||||
---
|
||||
# SimpleX Chat User Guide
|
||||
|
||||
The first messaging platform that has no user identifiers of any kind — 100% private by design.
|
||||
|
||||
@@ -1,3 +1,6 @@
|
||||
---
|
||||
title: App settings
|
||||
---
|
||||
# App settings
|
||||
|
||||
## Opening the app settings
|
||||
|
||||
@@ -1,3 +1,6 @@
|
||||
---
|
||||
title: Audio & video Calls
|
||||
---
|
||||
# Audio and Video Calls
|
||||
|
||||
SimpleX Chat allows you to make end-to-end encrypted audio and video calls with your contacts via WebRTC. Note: Group calls are not supported at this time.
|
||||
|
||||
@@ -1,3 +1,6 @@
|
||||
---
|
||||
title: Chat profiles
|
||||
---
|
||||
# Your chat profiles
|
||||
|
||||
## Creating additional chat profiles
|
||||
|
||||
@@ -1,3 +1,6 @@
|
||||
---
|
||||
title: Making connections
|
||||
---
|
||||
# Connect to somebody in the chat
|
||||
|
||||
_Work in progress_
|
||||
|
||||
@@ -1,3 +1,6 @@
|
||||
---
|
||||
title: Managing data
|
||||
---
|
||||
# Managing Your Data
|
||||
|
||||
## Automatic message deletion
|
||||
|
||||
@@ -1,3 +1,6 @@
|
||||
---
|
||||
title: Privacy & security
|
||||
---
|
||||
# Privacy and Security
|
||||
|
||||
SimpleX Chat default configuration aims to balance privacy, security and convenience. You may want to change the default options.
|
||||
|
||||
@@ -1,3 +1,6 @@
|
||||
---
|
||||
title: Secret groups
|
||||
---
|
||||
# Secret groups
|
||||
|
||||
Secret groups are anonymous and private, they are designed to be hard to track by outsiders. Every message and file gets sent separately to every member in the group, which makes secret groups only fit for smaller groups.
|
||||
|
||||
@@ -1,3 +1,6 @@
|
||||
---
|
||||
title: Sending messages
|
||||
---
|
||||
# Sending, editing and deleting messages
|
||||
|
||||
Sending text messages on SimpleX Chat is pretty straightforward, tap on your contact and then tap on text area, type in your message and tap on "Send" button.
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
title: Přístup k souborům v aplikaci Android
|
||||
revision: 07.02.2023
|
||||
---
|
||||
| Aktualizováno 07.02.2023 | Jazyky: CZ, [EN](/docs/ANDROID.md) |
|
||||
|
||||
# Přístup k souborům v aplikaci Android
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
title: SimpleX Chat terminálová
|
||||
revision: 31.01.2023
|
||||
---
|
||||
| Aktualizováno 31.01.2023 | Jazyky: CZ, [EN](/docs/CLI.md), [FR](/docs/lang/fr/CLI.md) |
|
||||
|
||||
# SimpleX Chat terminálová (konzolová) aplikace pro Linux/MacOS/Windows
|
||||
@@ -174,7 +178,7 @@ Po spuštění chatu budete vyzváni k zadání svého "zobrazovacího jména" a
|
||||
Následující schéma ukazuje, jak se připojit ke kontaktu a poslat mu zprávu:
|
||||
|
||||
<div align="center">
|
||||
<img align="center" src="../images/how-to-use-simplex.svg">
|
||||
<img align="center" src="/images/how-to-use-simplex.svg">
|
||||
</div>
|
||||
|
||||
Po nastavení místního profilu zadejte `/c` (pro `/connect`) pro vytvoření nového spojení a vygenerování pozvánky. Tuto pozvánku odešlete svému kontaktu prostřednictvím jakéhokoli jiného kanálu.
|
||||
@@ -193,7 +197,7 @@ Seznam dostupných příkazů zobrazíte pomocí `/help` v chatu.
|
||||
|
||||
Skupinu vytvoříte příkazem `/g <group>` a kontakty do ní přidáte příkazem `/a <group> <name>`. Do skupiny pak můžete posílat zprávy zadáním `#<skupina> <zpráva>`. Pro další příkazy použijte `/help groups`.
|
||||
|
||||

|
||||

|
||||
|
||||
> **Upozornění**: skupiny nejsou uloženy na žádném serveru, jsou vedeny jako seznam členů v databázi aplikace, kterým budou zprávy zasílány.
|
||||
|
||||
@@ -201,7 +205,7 @@ Skupinu vytvoříte příkazem `/g <group>` a kontakty do ní přidáte příkaz
|
||||
|
||||
Soubor můžete odeslat kontaktu pomocí `/f @<contact> <soubor_cesta>` - příjemce jej bude muset před odesláním přijmout. Pro další příkazy použijte `/help files`.
|
||||
|
||||

|
||||

|
||||
|
||||
Soubory můžete posílat skupině pomocí `/f #<skupina> <soubor_cesta>`.
|
||||
|
||||
@@ -215,7 +219,7 @@ Uživatelská adresa je "dlouhodobá" v tom smyslu, že se jedná o odkaz pro v
|
||||
|
||||
Pro ostatní příkazy použijte `/help address`.
|
||||
|
||||

|
||||

|
||||
|
||||
### Přístup k historii chatu
|
||||
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
title: Průvodce přispíváním
|
||||
revision: 31.01.2023
|
||||
---
|
||||
| Aktualizováno 31.01.2023 | Jazyky: CZ, [EN](/docs/CONTRIBUTING.md), [FR](/docs/lang/fr/CONTRIBUTING.md) |
|
||||
|
||||
# Průvodce přispíváním
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
title: Hostování vlastního serveru SMP
|
||||
revision: 31.01.2023
|
||||
---
|
||||
| Aktualizováno 31.01.2023 | Jazyky: CZ, [EN](/docs/SERVER.md), [FR](/docs/lang/fr/SERVER.md) |
|
||||
|
||||
# Hostování vlastního serveru SMP
|
||||
@@ -327,4 +331,4 @@ Adresu svého serveru můžete také sdílet se svými přáteli tak, že je nec
|
||||
|
||||
_Upozornění_: pro podporu hesla je třeba mít SMP server verze 4.0. Pokud již máte nasazený server, můžete heslo přidat přidáním do souboru INI serveru.
|
||||
|
||||
<img src="./server_config_1.png" width="288"> <img src="./server_config_2.png" width="288"> <img src="./server_config_3.png" width="288">
|
||||
<img src="/docs/server_config_1.png" width="288"> <img src="/docs/server_config_2.png" width="288"> <img src="/docs/server_config_3.png" width="288">
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
title: Platforma SimpleX
|
||||
revision: 07.02.2023
|
||||
---
|
||||
| Aktualizováno 07.02.2023 | Jazyky: CZ, [EN](/docs/SIMPLEX.md), [FR](/docs/lang/fr/SIMPLEX.md) |
|
||||
|
||||
# Platforma SimpleX - motivace a srovnání
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
title: Přístup ke zprávám v databázi
|
||||
revision: 31.01.2023
|
||||
---
|
||||
| Aktualizováno 31.01.2023 | Jazyky: CZ, [EN](/docs/SQL.md), [FR](/docs/lang/fr/SQL.md) |
|
||||
|
||||
# Přístup ke zprávám v databázi
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
title: Přispívání překladů do SimpleX Chat
|
||||
revision: 07.02.2023
|
||||
---
|
||||
| Aktualizováno 07.02.2023 | Jazyky: CZ, [EN](/docs/TRANSLATIONS.md) |
|
||||
|
||||
# Přispívání překladů do SimpleX Chat
|
||||
@@ -22,7 +26,7 @@ Tento dokument vznikl proto, abychom tento proces urychlili, a podělili se s v
|
||||
|
||||
2. Některé řetězce není třeba překládat, ale přesto je třeba je překopírovat - v uživatelském rozhraní Weblate je k tomu tlačítko:
|
||||
|
||||
<img src="./images/weblate_1.png" alt="weblate: zkopírovat zdroj do překladu" width="100%">
|
||||
<img src="/docs/images/weblate_1.png" alt="weblate: zkopírovat zdroj do překladu" width="100%">
|
||||
|
||||
3. Weblate má také automatické návrhy, které mohou proces urychlit. Někdy je lze použít tak, jak jsou, jindy je třeba je upravit - kliknutím je použijete v překladu.
|
||||
|
||||
@@ -30,7 +34,7 @@ Tento dokument vznikl proto, abychom tento proces urychlili, a podělili se s v
|
||||
|
||||
5. Při překladu [aplikace pro iOS](https://hosted.weblate.org/projects/simplex-chat/ios/) je velká část řetězců naprosto stejná - lze je jedním kliknutím překopírovat do sekce glosář. Vizuální nápovědou, že to lze provést, je to, že celý zdrojový řetězec je zvýrazněn žlutě. Mnoho dalších řetězců je velmi podobných, liší se pouze syntaxí interpolace nebo způsobem použití tučného písma - vyžadují minimální úpravy. Existují některé řetězce, které jsou jedinečné pro platformu iOS - ty je třeba přeložit zvlášť.
|
||||
|
||||
<img src="./images/weblate_2.png" alt="weblate: automatické návrhy" width="100%">
|
||||
<img src="/docs/images/weblate_2.png" alt="weblate: automatické návrhy" width="100%">
|
||||
|
||||
## Po dokončení překladu
|
||||
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
title: Použití vlastních serverů WebRTC ICE v SimpleX Chat
|
||||
revision: 31.01.2023
|
||||
---
|
||||
| Aktualizováno 31.01.2023 | Jazyky: CZ, [EN](/docs/WEBRTC.md), [FR](/docs/lang/fr/WEBRTC.md) |
|
||||
|
||||
# Použití vlastních serverů WebRTC ICE v SimpleX Chat
|
||||
@@ -124,7 +128,7 @@ To je vše - nyní můžete uskutečňovat audio a video hovory prostřednictví
|
||||
|
||||
2. Do části **Sestavit seznam serverů ICE** přidejte:
|
||||
|
||||
<img src="./stun_1.png">.
|
||||
<img src="/docs/stun_1.png">.
|
||||
|
||||
- `STUN: stun:<vaše_ip_nebo_doména>:<port>` a stiskněte `Add STUN`.
|
||||
- `TURN: turn:<vaše_ip_nebo_doména>:<port>`, `Username: <vaše_přihlašovací jméno>`, `Credential: <vaš_pas>` a stiskněte `Add TURN`
|
||||
@@ -133,10 +137,10 @@ To je vše - nyní můžete uskutečňovat audio a video hovory prostřednictví
|
||||
|
||||
3. Měli byste vidět své servery v sekci **ICE server list**. Pokud je vše správně nastaveno, stiskněte `Start test`:
|
||||
|
||||
<img src="./stun_2.png">
|
||||
<img src="/docs/stun_2.png">
|
||||
|
||||
4. V části **Výsledky** byste měli vidět něco takového:
|
||||
|
||||
<img src="./stun_3.png">
|
||||
<img src="/docs/stun_3.png">
|
||||
|
||||
Pokud výsledky zobrazují kandidáty `srflx` a `relay`, je vše nastaveno správně!
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
title: Accès aux fichiers dans l'application Android
|
||||
revision: 07.02.2023
|
||||
---
|
||||
| 07.02.2023 | FR, [EN](/docs/ANDROID.md), [CZ](/docs/lang/cs/ANDROID.md) |
|
||||
|
||||
# Accès aux fichiers dans l'application Android
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
title: Application de terminal
|
||||
revision: 31.01.2023
|
||||
---
|
||||
| 31.01.2023 | FR, [EN](/docs/CLI.md), [CZ](/docs/lang/cs/CLI.md) |
|
||||
|
||||
# Application de terminal (console) SimpleX Chat pour Linux/MacOS/Windows
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
title: Guide pour contribuer
|
||||
revision: 31.01.2023
|
||||
---
|
||||
| 31.01.2023 | FR, [EN](/docs/CONTRIBUTING.md), [CZ](/docs/lang/cs/CONTRIBUTING.md) |
|
||||
|
||||
# Guide pour contribuer
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
title: Héberger votre propre serveur SMP
|
||||
revision: 31.01.2023
|
||||
---
|
||||
| 31.01.2023 | FR, [EN](/docs/SERVER.md), [CZ](/docs/lang/cs/SERVER.md) |
|
||||
|
||||
# Héberger votre propre serveur SMP
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
title: Plateforme SimpleX
|
||||
revision: 07.02.2023
|
||||
---
|
||||
| 07.02.2023 | FR, [EN](/docs/SIMPLEX.md), [CZ](/docs/lang/cs/SIMPLEX.md) |
|
||||
|
||||
# Plateforme SimpleX - motivation et comparaison
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
title: Accès aux messages de la base de données
|
||||
revision: 31.01.2023
|
||||
---
|
||||
| 31.01.2023 | FR, [EN](/docs/SQL.md), [CZ](/docs/lang/cs/SQL.md) |
|
||||
|
||||
# Accès aux messages de la base de données
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
title: Contribuer aux traductions de SimpleX Chat
|
||||
revision: 19.03.2023
|
||||
---
|
||||
| 19.03.2023 | FR, [EN](/docs/TRANSLATIONS.md), [CZ](/docs/lang/cs/TRANSLATIONS.md) |
|
||||
|
||||
# Contribuer aux traductions de SimpleX Chat
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
title: Utilisation de serveurs WebRTC ICE personnalisés dans SimpleX Chat
|
||||
revision: 31.01.2023
|
||||
---
|
||||
| 31.01.2023 | FR, [EN](/docs/WEBRTC.md), [CZ](/docs/lang/cs/WEBRTC.md) |
|
||||
|
||||
# Utilisation de serveurs WebRTC ICE personnalisés dans SimpleX Chat
|
||||
|
||||
@@ -1,3 +1,7 @@
|
||||
---
|
||||
title: SimpleX Chat Protocol
|
||||
revision: 08.08.2022
|
||||
---
|
||||
DRAFT Revision 0.1, 2022-08-08
|
||||
|
||||
Evgeny Poberezkin
|
||||
|
||||
Reference in New Issue
Block a user