Skip to content

Commit f97a1fc

Browse files
MSarmadQadeerepoberezkin
MSarmadQadeer
and
epoberezkin
authored
website: add docs to website (simplex-chat#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 <[email protected]>
1 parent 315d830 commit f97a1fc

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

54 files changed

+1321
-94
lines changed

Diff for: ‎.gitignore

+1-1
Original file line numberDiff line numberDiff line change
@@ -49,8 +49,8 @@ logs/
4949
# for website
5050
website/node_modules/
5151
website/src/blog/
52+
website/src/docs/
5253
website/translations.json
53-
website/src/_data/supported_languages.json
5454
website/src/img/images/
5555
website/src/images/
5656
# Generated files

Diff for: ‎docs/ANDROID.md

+5
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
title: Accessing files in Android app
3+
revision: 07.02.2023
4+
---
5+
16
| 07.02.2023 | EN, [CZ](/docs/lang/cs/ANDROID.md), [FR](/docs/lang/fr/ANDROID.md) |
27

38
# Accessing files in Android app

Diff for: ‎docs/CLI.md

+5
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
title: Terminal CLI
3+
revision: 31.01.2023
4+
---
5+
16
| Updated 31.01.2023 | Languages: EN, [FR](/docs/lang/fr/CLI.md), [CZ](/docs/lang/cs/CLI.md) |
27

38
# SimpleX Chat terminal (console) app for Linux/MacOS/Windows

Diff for: ‎docs/CONTRIBUTING.md

+5
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
title: Contributing guide
3+
revision: 31.01.2023
4+
---
5+
16
| Updated 31.01.2023 | Languages: EN, [FR](/docs/lang/fr/CONTRIBUTING.md), [CZ](/docs/lang/cs/CONTRIBUTING.md) |
27

38
# Contributing guide

Diff for: ‎docs/SERVER.md

+5
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
title: Hosting your own SMP Server
3+
revision: 31.01.2023
4+
---
5+
16
| Updated 31.01.2023 | Languages: EN, [FR](/docs/lang/fr/SERVER.md), [CZ](/docs/lang/cs/SERVER.md) |
27

38
# Hosting your own SMP Server

Diff for: ‎docs/SIMPLEX.md

+5
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
title: SimpleX platform
3+
revision: 07.02.2023
4+
---
5+
16
| Updated 07.02.2023 | Languages: EN, [FR](/docs/lang/fr/SIMPLEX.md), [CZ](/docs/lang/cs/SIMPLEX.md) |
27
# SimpleX platform - motivation and comparison
38

Diff for: ‎docs/SQL.md

+5
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
title: Accessing messages in the database
3+
revision: 31.01.2023
4+
---
5+
16
| Updated 31.01.2023 | Languages: EN, [FR](/docs/lang/fr/SQL.md), [CZ](/docs/lang/cs/SQL.md) |
27

38
# Accessing messages in the database

Diff for: ‎docs/TRANSLATIONS.md

+5
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
title: Contributing translations to SimpleX Chat
3+
revision: 19.03.2023
4+
---
5+
16
| 19.03.2023 | EN, [CZ](/docs/lang/cs/TRANSLATIONS.md), [FR](/docs/lang/fr/TRANSLATIONS.md) |
27

38
# Contributing translations to SimpleX Chat

Diff for: ‎docs/WEBRTC.md

+5
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
title: Using custom WebRTC ICE servers in SimpleX Chat
3+
revision: 31.01.2023
4+
---
5+
16
| Updated 31.01.2023 | Languages: EN, [FR](/docs/lang/fr/WEBRTC.md), [CZ](/docs/lang/cs/WEBRTC.md) |
27

38
# Using custom WebRTC ICE servers in SimpleX Chat

Diff for: ‎docs/XFTP-SERVER.md

+4
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
title: Hosting your own XFTP Server
3+
revision: 21.04.2023
4+
---
15
# Hosting your own XFTP Server
26

37
## Overview

Diff for: ‎docs/guide/README.md

+3
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
---
2+
title: Quick start
3+
---
14
# SimpleX Chat User Guide
25

36
The first messaging platform that has no user identifiers of any kind — 100% private by design.

Diff for: ‎docs/guide/app-settings.md

+3
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
---
2+
title: App settings
3+
---
14
# App settings
25

36
## Opening the app settings

Diff for: ‎docs/guide/audio-video-calls.md

+3
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
---
2+
title: Audio & video Calls
3+
---
14
# Audio and Video Calls
25

36
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.

Diff for: ‎docs/guide/chat-profiles.md

+3
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
---
2+
title: Chat profiles
3+
---
14
# Your chat profiles
25

36
## Creating additional chat profiles

Diff for: ‎docs/guide/making-connections.md

+3
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
---
2+
title: Making connections
3+
---
14
# Connect to somebody in the chat
25

36
_Work in progress_

Diff for: ‎docs/guide/managing-data.md

+3
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
---
2+
title: Managing data
3+
---
14
# Managing Your Data
25

36
## Automatic message deletion

Diff for: ‎docs/guide/privacy-security.md

+3
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
---
2+
title: Privacy & security
3+
---
14
# Privacy and Security
25

36
SimpleX Chat default configuration aims to balance privacy, security and convenience. You may want to change the default options.

Diff for: ‎docs/guide/secret-groups.md

+3
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
---
2+
title: Secret groups
3+
---
14
# Secret groups
25

36
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.

Diff for: ‎docs/guide/send-messages.md

+3
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
---
2+
title: Sending messages
3+
---
14
# Sending, editing and deleting messages
25

36
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.

Diff for: ‎docs/lang/cs/ANDROID.md

+4
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
title: Přístup k souborům v aplikaci Android
3+
revision: 07.02.2023
4+
---
15
| Aktualizováno 07.02.2023 | Jazyky: CZ, [EN](/docs/ANDROID.md) |
26

37
# Přístup k souborům v aplikaci Android

Diff for: ‎docs/lang/cs/CLI.md

+8-4
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
title: SimpleX Chat terminálová
3+
revision: 31.01.2023
4+
---
15
| Aktualizováno 31.01.2023 | Jazyky: CZ, [EN](/docs/CLI.md), [FR](/docs/lang/fr/CLI.md) |
26

37
# 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
174178
Následující schéma ukazuje, jak se připojit ke kontaktu a poslat mu zprávu:
175179

176180
<div align="center">
177-
<img align="center" src="../images/how-to-use-simplex.svg">
181+
<img align="center" src="/images/how-to-use-simplex.svg">
178182
</div>
179183

180184
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,15 +197,15 @@ Seznam dostupných příkazů zobrazíte pomocí `/help` v chatu.
193197

194198
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`.
195199

196-
![simplex-chat](../images/groups.gif)
200+
![simplex-chat](/images/groups.gif)
197201

198202
> **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.
199203
200204
### Odesílání souborů
201205

202206
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`.
203207

204-
![simplex-chat](../images/files.gif)
208+
![simplex-chat](/images/files.gif)
205209

206210
Soubory můžete posílat skupině pomocí `/f #<skupina> <soubor_cesta>`.
207211

@@ -215,7 +219,7 @@ Uživatelská adresa je "dlouhodobá" v tom smyslu, že se jedná o odkaz pro v
215219

216220
Pro ostatní příkazy použijte `/help address`.
217221

218-
![simplex-chat](../images/user-addresses.gif)
222+
![simplex-chat](/images/user-addresses.gif)
219223

220224
### Přístup k historii chatu
221225

Diff for: ‎docs/lang/cs/CONTRIBUTING.md

+4
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
title: Průvodce přispíváním
3+
revision: 31.01.2023
4+
---
15
| Aktualizováno 31.01.2023 | Jazyky: CZ, [EN](/docs/CONTRIBUTING.md), [FR](/docs/lang/fr/CONTRIBUTING.md) |
26

37
# Průvodce přispíváním

Diff for: ‎docs/lang/cs/SERVER.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
title: Hostování vlastního serveru SMP
3+
revision: 31.01.2023
4+
---
15
| Aktualizováno 31.01.2023 | Jazyky: CZ, [EN](/docs/SERVER.md), [FR](/docs/lang/fr/SERVER.md) |
26

37
# 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
327331

328332
_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.
329333

330-
<img src="./server_config_1.png" width="288"> &nbsp;&nbsp; <img src="./server_config_2.png" width="288"> &nbsp;&nbsp; <img src="./server_config_3.png" width="288">
334+
<img src="/docs/server_config_1.png" width="288"> &nbsp;&nbsp; <img src="/docs/server_config_2.png" width="288"> &nbsp;&nbsp; <img src="/docs/server_config_3.png" width="288">

Diff for: ‎docs/lang/cs/SIMPLEX.md

+4
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
title: Platforma SimpleX
3+
revision: 07.02.2023
4+
---
15
| Aktualizováno 07.02.2023 | Jazyky: CZ, [EN](/docs/SIMPLEX.md), [FR](/docs/lang/fr/SIMPLEX.md) |
26

37
# Platforma SimpleX - motivace a srovnání

Diff for: ‎docs/lang/cs/SQL.md

+4
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
title: Přístup ke zprávám v databázi
3+
revision: 31.01.2023
4+
---
15
| Aktualizováno 31.01.2023 | Jazyky: CZ, [EN](/docs/SQL.md), [FR](/docs/lang/fr/SQL.md) |
26

37
# Přístup ke zprávám v databázi

Diff for: ‎docs/lang/cs/TRANSLATIONS.md

+6-2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
title: Přispívání překladů do SimpleX Chat
3+
revision: 07.02.2023
4+
---
15
| Aktualizováno 07.02.2023 | Jazyky: CZ, [EN](/docs/TRANSLATIONS.md) |
26

37
# Přispívání překladů do SimpleX Chat
@@ -22,15 +26,15 @@ Tento dokument vznikl proto, abychom tento proces urychlili, a podělili se s v
2226

2327
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:
2428

25-
<img src="./images/weblate_1.png" alt="weblate: zkopírovat zdroj do překladu" width="100%">
29+
<img src="/docs/images/weblate_1.png" alt="weblate: zkopírovat zdroj do překladu" width="100%">
2630

2731
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.
2832

2933
4. Jakmile jsou všechny řetězce v aplikaci pro Android přeloženy, zkontrolujte je, abyste zajistili konzistentní styl a jazyk, aby se pro podobné uživatelské akce důsledně používala stejná slova jako v angličtině. Někdy budete muset použít různá slova v případech, kdy angličtina má jen jedno, snažte se prosím tyto volby používat důsledně v podobných kontextech, aby to bylo pro koncové uživatele jednodušší.
3034

3135
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ášť.
3236

33-
<img src="./images/weblate_2.png" alt="weblate: automatické návrhy" width="100%">
37+
<img src="/docs/images/weblate_2.png" alt="weblate: automatické návrhy" width="100%">
3438

3539
## Po dokončení překladu
3640

Diff for: ‎docs/lang/cs/WEBRTC.md

+7-3
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
title: Použití vlastních serverů WebRTC ICE v SimpleX Chat
3+
revision: 31.01.2023
4+
---
15
| Aktualizováno 31.01.2023 | Jazyky: CZ, [EN](/docs/WEBRTC.md), [FR](/docs/lang/fr/WEBRTC.md) |
26

37
# 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í
124128

125129
2. Do části **Sestavit seznam serverů ICE** přidejte:
126130

127-
<img src="./stun_1.png">.
131+
<img src="/docs/stun_1.png">.
128132

129133
- `STUN: stun:<vaše_ip_nebo_doména>:<port>` a stiskněte `Add STUN`.
130134
- `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í
133137

134138
3. Měli byste vidět své servery v sekci **ICE server list**. Pokud je vše správně nastaveno, stiskněte `Start test`:
135139

136-
<img src="./stun_2.png">
140+
<img src="/docs/stun_2.png">
137141

138142
4. V části **Výsledky** byste měli vidět něco takového:
139143

140-
<img src="./stun_3.png">
144+
<img src="/docs/stun_3.png">
141145

142146
Pokud výsledky zobrazují kandidáty `srflx` a `relay`, je vše nastaveno správně!

Diff for: ‎docs/lang/fr/ANDROID.md

+4
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
title: Accès aux fichiers dans l'application Android
3+
revision: 07.02.2023
4+
---
15
| 07.02.2023 | FR, [EN](/docs/ANDROID.md), [CZ](/docs/lang/cs/ANDROID.md) |
26

37
# Accès aux fichiers dans l'application Android

Diff for: ‎docs/lang/fr/CLI.md

+4
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
title: Application de terminal
3+
revision: 31.01.2023
4+
---
15
| 31.01.2023 | FR, [EN](/docs/CLI.md), [CZ](/docs/lang/cs/CLI.md) |
26

37
# Application de terminal (console) SimpleX Chat pour Linux/MacOS/Windows

Diff for: ‎docs/lang/fr/CONTRIBUTING.md

+4
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
title: Guide pour contribuer
3+
revision: 31.01.2023
4+
---
15
| 31.01.2023 | FR, [EN](/docs/CONTRIBUTING.md), [CZ](/docs/lang/cs/CONTRIBUTING.md) |
26

37
# Guide pour contribuer

Diff for: ‎docs/lang/fr/SERVER.md

+4
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
title: Héberger votre propre serveur SMP
3+
revision: 31.01.2023
4+
---
15
| 31.01.2023 | FR, [EN](/docs/SERVER.md), [CZ](/docs/lang/cs/SERVER.md) |
26

37
# Héberger votre propre serveur SMP

Diff for: ‎docs/lang/fr/SIMPLEX.md

+4
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
title: Plateforme SimpleX
3+
revision: 07.02.2023
4+
---
15
| 07.02.2023 | FR, [EN](/docs/SIMPLEX.md), [CZ](/docs/lang/cs/SIMPLEX.md) |
26

37
# Plateforme SimpleX - motivation et comparaison

Diff for: ‎docs/lang/fr/SQL.md

+4
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
title: Accès aux messages de la base de données
3+
revision: 31.01.2023
4+
---
15
| 31.01.2023 | FR, [EN](/docs/SQL.md), [CZ](/docs/lang/cs/SQL.md) |
26

37
# Accès aux messages de la base de données

Diff for: ‎docs/lang/fr/TRANSLATIONS.md

+4
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
title: Contribuer aux traductions de SimpleX Chat
3+
revision: 19.03.2023
4+
---
15
| 19.03.2023 | FR, [EN](/docs/TRANSLATIONS.md), [CZ](/docs/lang/cs/TRANSLATIONS.md) |
26

37
# Contribuer aux traductions de SimpleX Chat

Diff for: ‎docs/lang/fr/WEBRTC.md

+4
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
title: Utilisation de serveurs WebRTC ICE personnalisés dans SimpleX Chat
3+
revision: 31.01.2023
4+
---
15
| 31.01.2023 | FR, [EN](/docs/WEBRTC.md), [CZ](/docs/lang/cs/WEBRTC.md) |
26

37
# Utilisation de serveurs WebRTC ICE personnalisés dans SimpleX Chat

Diff for: ‎docs/protocol/simplex-chat.md

+4
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
title: SimpleX Chat Protocol
3+
revision: 08.08.2022
4+
---
15
DRAFT Revision 0.1, 2022-08-08
26

37
Evgeny Poberezkin

0 commit comments

Comments
 (0)