From ceb7a25a8647b5474d32dae3aa537b6534643884 Mon Sep 17 00:00:00 2001 From: Yunobot Date: Sun, 15 Nov 2020 16:10:16 +0100 Subject: [PATCH] (Grav GitSync) Automatic Commit from Yunobot --- .../01.whatisyunohost/whatsyunohost.fr.md | 2 +- .../01.whatisyunohost/whatsyunohost.md | 35 +++--- .../01.selfhosting/02.tryyunohost/try.md | 33 ++---- .../03.howtohostyourself/howtohostyourself.md | 2 +- .../02.install/00.hardware/hardware.md | 2 +- .../01.iso/03.images/flex-objects.md | 8 ++ .../02.install/01.iso/install_iso.md | 17 ++- pages/01.administrate/02.install/install.md | 107 +++++++----------- pages/01.administrate/admindoc.fr.md | 69 +---------- pages/01.administrate/admindoc.md | 69 +---------- pages/02.contribute/contributordoc.md | 2 +- .../yunohost_project_organization.fr.md | 2 +- .../yunohost_project_organization.md | 2 +- .../04.sponsors/sponsors_partners.fr.md | 7 +- .../04.sponsors/sponsors_partners.md | 7 +- pages/home/docs.md | 20 +--- .../learn4/templates/macros/macros.html.twig | 2 +- themes/yunohost-docs/css/custom.css | 34 ++++++ themes/yunohost-docs/languages.yaml | 43 +++++++ themes/yunohost-docs/templates/docs.html.twig | 20 ++++ .../templates/macros/macros.html.twig | 35 ++++++ .../templates/partials/base.html.twig | 1 + .../templates/partials/sidebar.html.twig | 44 +++++++ 23 files changed, 295 insertions(+), 268 deletions(-) create mode 100644 pages/01.administrate/02.install/01.iso/03.images/flex-objects.md create mode 100644 themes/yunohost-docs/languages.yaml create mode 100644 themes/yunohost-docs/templates/docs.html.twig create mode 100644 themes/yunohost-docs/templates/macros/macros.html.twig create mode 100644 themes/yunohost-docs/templates/partials/sidebar.html.twig diff --git a/pages/01.administrate/01.selfhosting/01.whatisyunohost/whatsyunohost.fr.md b/pages/01.administrate/01.selfhosting/01.whatisyunohost/whatsyunohost.fr.md index 3aaa911e..894d6f4e 100644 --- a/pages/01.administrate/01.selfhosting/01.whatisyunohost/whatsyunohost.fr.md +++ b/pages/01.administrate/01.selfhosting/01.whatisyunohost/whatsyunohost.fr.md @@ -5,7 +5,7 @@ taxonomy: category: docs --- - +![YunoHost logo](image://YunoHost_logo_vertical.png?resize=400) YunoHost est un **système d’exploitation** qui vise à simplifier autant que possible l'administration d'un **serveur** pour ainsi démocratiser [l’auto-hébergement](/selfhosting) tout en restant fiable, sécurisé, éthique et léger. C'est un projet de logiciel libre maintenu exclusivement par des bénévoles. Techniquement, il peut être vu comme une distribution basée sur [Debian GNU/Linux](https://debian.org) et peut s'installer sur [de nombreux types de matériel](/install). diff --git a/pages/01.administrate/01.selfhosting/01.whatisyunohost/whatsyunohost.md b/pages/01.administrate/01.selfhosting/01.whatisyunohost/whatsyunohost.md index 75aacd67..cb3ed7ec 100644 --- a/pages/01.administrate/01.selfhosting/01.whatisyunohost/whatsyunohost.md +++ b/pages/01.administrate/01.selfhosting/01.whatisyunohost/whatsyunohost.md @@ -5,29 +5,29 @@ taxonomy: category: docs --- - +![YunoHost logo](image://YunoHost_logo_vertical.png?resize=400) YunoHost is an **operating system** aiming for the simplest administration of a **server**, and therefore democratize [self-hosting](selfhosting), while making sure it stays reliable, secure, ethical and lightweight. It is a copylefted libre software project maintained exclusively by volunteers. Technically, it can be seen as a distribution based on [Debian GNU/Linux](https://debian.org) and can be installed on [many kinds of hardware](install). ## Features -- Based on Debian; -- Administrate your server through a **friendly web interface** ; -- Deploy **apps in just a few clicks**; -- Manage **users** (based on LDAP); -- Manage **domain names**; -- Create and restore **backups**; -- Connect to all apps simultaneously through the **user portal** (NGINX, SSOwat); -- Includes a **full e-mail stack** (Postfix, Dovecot, Rspamd, DKIM); -- ... as well as **an instant messaging server** (XMPP); -- Manages **SSL certificates** (based on Let's Encrypt) ; -- ... and **security systems** (Fail2ban, yunohost-firewall); +- ![](image://icon-debian.png?resize=32&classes=inline) Based on Debian; +- ![](image://icon-tools.png?resize=32&classes=inline) Administrate your server through a **friendly web interface** ; +- ![](image://icon-package.png?resize=32&classes=inline) Deploy **apps in just a few clicks**; +- ![](image://icon-users.png?resize=32&classes=inline) Manage **users** (based on LDAP); +- ![](image://icon-globe.png?resize=32&classes=inline) Manage **domain names**; +- ![](image://icon-medic.png?resize=32&classes=inline) Create and restore **backups**; +- ![](image://icon-door.png?resize=32&classes=inline) Connect to all apps simultaneously through the **user portal** (NGINX, SSOwat); +- ![](image://icon-mail.png?resize=32&classes=inline) Includes a **full e-mail stack** (Postfix, Dovecot, Rspamd, DKIM); +- ![](image://icon-messaging.png?resize=32&classes=inline)... as well as **an instant messaging server** (XMPP); +- ![](image://icon-lock.png?resize=32&classes=inline) Manages **SSL certificates** (based on Let's Encrypt) ; +- ![](image://icon-shield.png?resize=32&classes=inline)... and **security systems** (Fail2ban, yunohost-firewall); ## Origin YunoHost was created in February 2012 after something like this: -

"Shit, I'm too lazy to reconfigure my mail server... Beudbeud, how were you able to get your little server running with LDAP?"

+

"Shit, I'm too lazy to reconfigure my mail server... Beudbeud, how were you able to get your little server running with LDAP?"

Kload, February 2012
All that was needed was an admin interface for Beudbeud's server to make something usable, so Kload decided to develop one. Finally, after automating several configs and packaging in some web apps, YunoHost v1 was finished. @@ -35,7 +35,7 @@ All that was needed was an admin interface for Beudbeud's server to make somethi Noting the growing enthusiasm around YunoHost and around self-hosting in general, the original developers along with new contributors decided to start work on version 2, a more extensible, more powerful, more easy-to-use, and at that, one that makes a nice cup of fair-trade coffee for the elves of Lapland. The name **YunoHost** comes from the jargon "Y U NO Host". The [Internet meme](https://en.wikipedia.org/wiki/Internet_meme) should illustrate it: -
+![](image://dude_yunohost.jpg) ## What YunoHost is not? @@ -49,10 +49,7 @@ You can host your friends, your family and your company safely and with ease, bu Black and white YunoHost PNG logo by ToZz (400 × 400 px): - - - - -Click to download. +[![](image://ynh_logo_black_300dpi.png?resize=220)](image://ynh_logo_black_300dpi.png) +[![](image://ynh_logo_white_300dpi.png?resize=220)](image://ynh_logo_white_300dpi.png) Licence: CC-BY-SA 4.0 diff --git a/pages/01.administrate/01.selfhosting/02.tryyunohost/try.md b/pages/01.administrate/01.selfhosting/02.tryyunohost/try.md index aeae0b49..1f816658 100644 --- a/pages/01.administrate/01.selfhosting/02.tryyunohost/try.md +++ b/pages/01.administrate/01.selfhosting/02.tryyunohost/try.md @@ -5,28 +5,17 @@ taxonomy: category: docs --- -
-**Note:** This demo server could be down from time to time. -
+! This demo server could be down from time to time. -
+[center] +[columns] +[ User interface](https://demo.yunohost.org/?target=_blank&classes=btn,btn-lg,btn-success) +Username: demo +Password: demo -
+[ Administration interface](https://demo.yunohost.org/yunohost/admin?target=_blank&classes=btn,btn-lg,btn-primary) +Password: demo

+[/columns] +[/center] -
-
- User interface -

Username: demo
Password: demo

-
-
- Administration interface -

Password: demo

-
-
- -
- -

-***Demo server gracefully provided by -Gitoyen*** -

+!!! **Demo server gracefully provided by [Gitoyen](https://www.gitoyen.net?target=_blank)** diff --git a/pages/01.administrate/01.selfhosting/03.howtohostyourself/howtohostyourself.md b/pages/01.administrate/01.selfhosting/03.howtohostyourself/howtohostyourself.md index 27bd0fc4..e2d1d287 100644 --- a/pages/01.administrate/01.selfhosting/03.howtohostyourself/howtohostyourself.md +++ b/pages/01.administrate/01.selfhosting/03.howtohostyourself/howtohostyourself.md @@ -12,7 +12,7 @@ You can host yourself at home (on a small computer), or on a remote server. Each You can host yourself at home with an ARM board or a re-purposed regular computer, connected to your home router/box. - **Pros** : you will have physical control of the machine and only need to buy the hardware; -- **Cons** : you will have to [manually configure your internet box](isp_box_config) and [might be limited by your ISP](isp). +- **Cons** : you will have to [manually configure your internet box](/administrate/postinstall/ispbox) and [might be limited by your ISP](/administrate/advance/isp). ### At home, behind a VPN diff --git a/pages/01.administrate/02.install/00.hardware/hardware.md b/pages/01.administrate/02.install/00.hardware/hardware.md index 4ca49d7a..5db26051 100644 --- a/pages/01.administrate/02.install/00.hardware/hardware.md +++ b/pages/01.administrate/02.install/00.hardware/hardware.md @@ -10,7 +10,7 @@ YunoHost can be installed on the following hardware : - 'Old' desktop computers or laptops ; - Remote servers, a.k.a Virtual Private Servers (VPS). -Corresponding installation guides can be found on [this page](/install). +Corresponding installation guides can be found on [this page](/administrate/install). ### Minimum requirements diff --git a/pages/01.administrate/02.install/01.iso/03.images/flex-objects.md b/pages/01.administrate/02.install/01.iso/03.images/flex-objects.md new file mode 100644 index 00000000..adb61a8d --- /dev/null +++ b/pages/01.administrate/02.install/01.iso/03.images/flex-objects.md @@ -0,0 +1,8 @@ +--- +title: YunoHost images +flex: + directory: images +--- + +# YunoHost images + diff --git a/pages/01.administrate/02.install/01.iso/install_iso.md b/pages/01.administrate/02.install/01.iso/install_iso.md index 8e88dfd1..bb6e0f52 100644 --- a/pages/01.administrate/02.install/01.iso/install_iso.md +++ b/pages/01.administrate/02.install/01.iso/install_iso.md @@ -5,18 +5,18 @@ taxonomy: category: docs --- -*Find other ways to install YunoHost **[here](/install)**.* +## Requirements -### Requirements - - - - +[center] +![Laptop](image://laptop.png?resize=200,200&class=inline) +![Desktop](image://desktop.jpg?resize=200,200&class=inline) +![Nettop](image://nettop.jpg?resize=200,200&class=inline) +[/center] * A x86-compatible hardware dedicated to YunoHost: laptop, nettop, netbook, desktop. You can use any computer with **256MB RAM or more**. * Another computer to read this guide and access to your server. -* A [reasonable ISP](/isp), preferably with a good and unlimited upstream bandwidth +* A [reasonable ISP](/administrate/advance/isp), preferably with a good and unlimited upstream bandwidth * A **USB stick** of at least 1GB capacity **OR** a standard **blank CD** * ***Particular case*** : If your server has no graphic card, [prepare iso for booting with serial port](https://github.com/luffah/debian-mkserialiso). @@ -24,8 +24,7 @@ You can use any computer with **256MB RAM or more**. ## Installation steps - -0. Download the YunoHost ISO image +[0. Download the YunoHost ISO image](/administrate/install/iso/images?classes=btn,btn-lg,btn-primary) 1. Burn the ISO image on a USB stick diff --git a/pages/01.administrate/02.install/install.md b/pages/01.administrate/02.install/install.md index 69cfe581..0b465bcf 100644 --- a/pages/01.administrate/02.install/install.md +++ b/pages/01.administrate/02.install/install.md @@ -5,91 +5,66 @@ taxonomy: category: docs --- -There are multiple ways to install YunoHost. The process may differ slightly depending on whether it takes place at home or on a remote server, and depending on the hardware used: **[See the requirements](/hardware)** +There are multiple ways to install YunoHost. The process may differ slightly depending on whether it takes place at home or on a remote server, and depending on the hardware used: **[See the requirements](hardware)**. This page lists a few installation guides. ---- +## Give it a try -

Give it a try

+[columns][center] -
+[[figure caption="Demo server"]![](image://logo.png?resize=150&class=inline)[/figure]](/administrate/selfhosting/tryyunohost) - +[[figure caption="Try with VirtualBox"] +![](image://virtualbox.png?resize=150&class=inline) +[/figure]](/administrate/install/virtualbox) - +[/center][/columns] -
+## Install at home +[columns count=3][center] +[[figure class="nomargin" caption="On a Raspberry Pi"] +![](image://raspberrypi.jpg?resize=150,150) +[/figure]](/administrate/install/rpi) + +[[figure class="nomargin" caption="On an ARM board"] +![](image://olinuxino.jpg?resize=150,150) +[/figure]](/administrate/install/arm) + +[[figure class="nomargin" caption="On a regular computer"] +![](image://computer.png?resize=150,150) +[/figure]](/administrate/install/iso) +[/center][/columns] - +## Install on a remote server -
+!!! [fa=fa-heart /] Local associative ISP near you might be able to provide you with a *Virtual Private Server* (VPS), managed by human beings who respect users and care about [Net Neutrality](https://en.wikipedia.org/wiki/Net_neutrality) ! Check out [this page](https://db.ffdn.org/) for more information. ---- +[center] -

Install at home

+[[figure class="nomargin" caption="On a dedicated or virtual private server"] +![](image://vps.png?resize=150,150) +[/figure]](/administrate/install/vps) -
+[/center] - +## Advanced / others - +[columns count=3][center] - +[[figure class="nomargin" caption="On Debian 10 Buster"] +![](image://debian-logo.png?resize=150,150) +[/figure]](/administrate/install/debian) -
+[[figure class="nomargin" caption="Dev environment in LXD/LXC"] +![](image://lxc.png?resize=150,150) +[/figure]](/contribute/dev) -
+[[figure class="nomargin" caption="(Non-official!) Docker images"] +![](image://docker.png?resize=150,150) +[/figure]](/administrate/install/docker) - ---- - -

Install on a remote server

- -
- Local associative ISP near you might be able to provide you with a *Virtual Private Server* (VPS), managed by human beings who respect users and care about [Net Neutrality](https://en.wikipedia.org/wiki/Net_neutrality) ! Check out [this page](https://db.ffdn.org/) for more information. -
- - - -
- ---- - -

Advanced / others

- - +[/center][/columns] diff --git a/pages/01.administrate/admindoc.fr.md b/pages/01.administrate/admindoc.fr.md index 3dc6f65b..4d379294 100644 --- a/pages/01.administrate/admindoc.fr.md +++ b/pages/01.administrate/admindoc.fr.md @@ -1,69 +1,10 @@ --- -title: Guide de l'administrateur -template: docs +title: Administrer +template: chapter taxonomy: category: docs --- -* Découvrir l'auto-hébergement - * [Qu'est-ce que l'auto-hébergement](/selfhosting) - * [Qu'est-ce que YunoHost](/whatsyunohost) - * [Essayer YunoHost](/try) - * [Choisir son mode d'hébergement](/howtohostyourself) - * [Matériel compatible](/hardware) - * [À propos des fournisseurs d'accès internet](/isp) -* [Guide d’installation](/install) - * [Sur un ordinateur "standard"](/install_iso) - * [Sur un serveur dédié ou virtuel (VPS)](/install_on_vps) - * [Sur un Raspberry Pi](/install_on_raspberry) - * [Sur une carte ARM](/install_on_arm_board) - * [Sur Debian](/install_on_debian) - * [Sur VirtualBox](/install_on_virtualbox) -* Finaliser son installation - * [Post-installation](/postinstall) - * [Configurer les redirections de port](/isp_box_config) - * [Configurer les enregistrements DNS](/dns_config) - * [Installer un certificat SSL](/certificate) - * [Diagnostic du bon fonctionnement du YunoHost](/diagnostic) -* Apprendre à connaitre YunoHost - * [Vue d'ensemble de YunoHost](/overview) - * [Conseil généraux](/guidelines) - * [L'interface d'administration web](/admin) - * [SSH](/ssh) et [l'administration en ligne de commande](/commandline) - * [Les utilisateurs et le SSO](/users) - * [Les groupes et les permissions](/groups_and_permissions) - * [Les applications](/apps_overview) - * [Les domaines, la configuration DNS et les certificats](/domains) - * [Les emails](/email) - * [Formulaires pour enlever son adresse IP des listes noires](/blacklist_forms) - * [XMPP](/XMPP) - * [Les sauvegardes](/backup) - * [Mettre à jour le système](/update) et [les applications](/app_update) - * [La sécurité](/security) -* Pour aller plus loin - * Noms de domaine - * [Nom de domaine en noho.st / nohost.me / ynh.fr](/dns_nohost_me) - * [Configurer un DNS dynamique avec une adresse IP dynamique](/dns_dynamicip) - * [DNS et installation d’une application sur un sous-domaine](/dns_subdomains) - * [Gérer les enregistrements DNS chez OVH](/OVH) - * Notes à propos de certains fournisseurs d'accès à Internet - * [SFR](/isp_sfr) - * [Orange](/isp_orange) - * [Free](/isp_free) - * [Documentation spécifique à certaines apps](/appsdoc) - * [Équivalence entre service Framasoft et apps](/apps_framasoft) - * [Échanger des fichiers avec son serveur à l'aide d'une interface graphique](/filezilla) - * [Modifier l'apparence du portail utilisateur](/theming) - * [Ajouter un stockage externe](/external_storage) - * [Déplacer un dossier d'app vers un autre stockage](/moving_app_folder) - * [Migrer ses emails vers YunoHost](/email_migration) - * [YunoHost avec un service caché Tor](/torhiddenservice) - * [Utilisation de certificats autres que Let's Encrypt](/certificate_custom) - * [Une discussion sur les avantages d'utiliser un VPN](/vpn_advantage) - * [Procedure de Migration Stretch->Buster](stretch_buster_migration) - * [(vieux) Procedure de Migration Jessie->Stretch](jessie_stretch_migration) -* Dépannage - * [Changer le mot de passe d’administration](/change_admin_password) - * [Récupérer l'accès à son serveur](/noaccess) - * [Débannir une IP dans Fail2Ban/IPtables](/fail2ban) - * [Configurer l'IPv6](/ipv6) +### Administrer + +# Découvrez l'auto-hébergement, comment installer et utiliser YunoHost diff --git a/pages/01.administrate/admindoc.md b/pages/01.administrate/admindoc.md index c18b677b..641ad506 100644 --- a/pages/01.administrate/admindoc.md +++ b/pages/01.administrate/admindoc.md @@ -1,69 +1,10 @@ --- -title: Administrator documentation -template: docs +title: Administrate +template: chapter taxonomy: category: docs --- -* Discovering self-hosting - * [What is Self-hosting](/selfhosting) - * [What is YunoHost](/whatsyunohost) - * [Try YunoHost](/try) - * [How to host yourself](howtohostyourself) - * [Choosing hardware](/hardware) - * [About the friendliness of internet service providers](/isp) -* [Installing YunoHost](/install) - * [On a regular computer](/install_iso) - * [On a dedicated or a virtual private server](/install_on_vps) - * [On a Raspberry Pi](/install_on_raspberry) - * [On an ARM board](/install_on_arm_board) - * [On Debian](/install_on_debian) - * [On VirtualBox](/install_on_virtualbox) -* Finalizing your setup - * [Post-installation](/postinstall) - * [Configuring port forwarding](/isp_box_config) - * [Configuring DNS records](/dns_config) - * [Installing an SSL certificate](/certificate) - * [Diagnose if your setup is working properly](/diagnostic) -* Getting to know YunoHost - * [Overview of YunoHost](/overview) - * [General advices and guidelines](/guidelines) - * [Web administration interface](/admin) - * [SSH](/ssh) and [command-line administration](/commandline) - * [Users and the SSO](/users) - * [Groups and permissions](/groups_and_permissions) - * [Applications](/apps_overview) - * [Domains, DNS and certificates](/domains) - * [Email](/email) - * [Forms to remove its IP address from the black lists](/blacklist_forms) - * [XMPP](/XMPP) - * [Backup](/backup) - * [Updating the system](/update) and [apps](/app_update) - * [Security](/security) -* Going further - * Domain names - * [Noho.st / nohost.me / ynh.fr domain names](/dns_nohost_me) - * [Configure a dynamic DNS with a dynamic IP address](/dns_dynamicip) - * [DNS and subdomains for apps](/dns_subdomains) - * [Managing DNS records at OVH](/OVH) - * Notes about some French ISPs - * [SFR](/isp_sfr) - * [Orange](/isp_orange) - * [Free](/isp_free) - * [Specific apps documentations](/appsdoc) - * [Equivalence between Framasoft service and apps](/apps_framasoft) - * [Exchange files with your server using a graphical interface](/filezilla) - * [Customize the appearance of the YunoHost portal](/theming) - * [Adding an external storage](/external_storage) - * [Moving an app folder to an other storage](/moving_app_folder) - * [Migrating emails to YunoHost](/email_migration) - * [Hide services with Tor](/torhiddenservice) - * [Using certificates other than Let's Encrypt](/certificate_custom) - * [A discussion about the advantages of using a VPN](/vpn_advantage) - * [Stretch->Buster migration procedure](stretch_buster_migration) - * [(old) Jessie->Stretch migration procedure](jessie_stretch_migration) -* Troubleshooting - * [Changing the administration password](/change_admin_password) - * [Recover access to your server](/noaccess) - * [Unban IPs in IPiptables/Fail2Ban](/fail2ban) - * [Configuring IPv6](/ipv6) +### Administrate + +# Discover self-hosting, how to install and use YunoHost diff --git a/pages/02.contribute/contributordoc.md b/pages/02.contribute/contributordoc.md index 35f244d4..0caf6b85 100644 --- a/pages/02.contribute/contributordoc.md +++ b/pages/02.contribute/contributordoc.md @@ -1,5 +1,5 @@ --- -title: Contributor documentation +title: Contribute template: docs taxonomy: category: docs diff --git a/pages/03.project/02.organization/yunohost_project_organization.fr.md b/pages/03.project/02.organization/yunohost_project_organization.fr.md index 247dd4ee..47667d45 100644 --- a/pages/03.project/02.organization/yunohost_project_organization.fr.md +++ b/pages/03.project/02.organization/yunohost_project_organization.fr.md @@ -1,5 +1,5 @@ --- -title: Organisation du projet YunoHost +title: Organisation du projet template: docs taxonomy: category: docs diff --git a/pages/03.project/02.organization/yunohost_project_organization.md b/pages/03.project/02.organization/yunohost_project_organization.md index dbc542e3..d87d08db 100644 --- a/pages/03.project/02.organization/yunohost_project_organization.md +++ b/pages/03.project/02.organization/yunohost_project_organization.md @@ -1,5 +1,5 @@ --- -title: YunoHost project organisation +title: Project organisation template: docs taxonomy: category: docs diff --git a/pages/03.project/04.sponsors/sponsors_partners.fr.md b/pages/03.project/04.sponsors/sponsors_partners.fr.md index af9ff92d..f491f6b8 100644 --- a/pages/03.project/04.sponsors/sponsors_partners.fr.md +++ b/pages/03.project/04.sponsors/sponsors_partners.fr.md @@ -1,4 +1,9 @@ -# Mécénes et partenaires +--- +title: Mécénes et partenaires +template: docs +taxonomy: + category: docs +--- Afin d'avancer et de faire fonctionner le projet, en plus du travail des bénévoles et des dons, YunoHost bénéficie du soutien de mécénes et de partenaires. diff --git a/pages/03.project/04.sponsors/sponsors_partners.md b/pages/03.project/04.sponsors/sponsors_partners.md index 640ff41b..df8a318e 100644 --- a/pages/03.project/04.sponsors/sponsors_partners.md +++ b/pages/03.project/04.sponsors/sponsors_partners.md @@ -1,4 +1,9 @@ -# Sponsors and partners +--- +title: Sponsors and partners +template: docs +taxonomy: + category: docs +--- In order to advance and make the project works, in addition to the work of volunteers and donations, YunoHost benefits from the support of sponsors and partners. diff --git a/pages/home/docs.md b/pages/home/docs.md index 89781561..0b2bc11f 100644 --- a/pages/home/docs.md +++ b/pages/home/docs.md @@ -5,26 +5,16 @@ taxonomy: category: docs --- -

YunoHost's documentation has 2 different sections: -

-
+[ Administrator's guide](/administrate?classes=btn,btn-lg,btn-primary) +Including installation, server management, and application management. -
- Administrator guide -

Including installation, server management and application management

-
- -
- Contributor guide -

Which contains everything you have to know about us and the way we work

-
- -
+[ Contributor's guide](/contribute?classes=btn,btn-lg,btn-error) +Which contains everything you have to know about us and the way we work. * Project's life: - * [Frequently asked questions](/faq) + * [Frequently asked questions](/help/faq) * [Project news](/news) * [Project organization](/project_organization) * [Project budget](/project_budget) diff --git a/themes/learn4/templates/macros/macros.html.twig b/themes/learn4/templates/macros/macros.html.twig index 2e876517..b3823800 100644 --- a/themes/learn4/templates/macros/macros.html.twig +++ b/themes/learn4/templates/macros/macros.html.twig @@ -33,4 +33,4 @@ {% endif %} {{ p.menu }} -{% endmacro %} \ No newline at end of file +{% endmacro %} diff --git a/themes/yunohost-docs/css/custom.css b/themes/yunohost-docs/css/custom.css index e4035f1f..a83f1801 100644 --- a/themes/yunohost-docs/css/custom.css +++ b/themes/yunohost-docs/css/custom.css @@ -2,3 +2,37 @@ background: linear-gradient(150deg, #8E1313 0, #0B1B41 100%); } +.highlightable h5:first-of-type { + margin-top: 2rem; +} + +.highlightable h5 { + margin-top: 1rem; + color: #ECECFE; +} + +#chapter { + max-width: 80%; +} + +img.inline { + display:inline; + margin:5px 15px 5px 5px; + vertical-align: middle; +} + +.nomargin * { + margin: 0px auto; +} + +#top-bar #breadcrumbs > span span, #top-bar #breadcrumbs > a span { + padding: 0 !important; +} + +#top-bar #breadcrumbs > span, #top-bar #breadcrumbs > a { + padding: 0 !important; +} + +#top-bar #breadcrumbs > a { + padding: 0; +} diff --git a/themes/yunohost-docs/languages.yaml b/themes/yunohost-docs/languages.yaml new file mode 100644 index 00000000..0c42fe06 --- /dev/null +++ b/themes/yunohost-docs/languages.yaml @@ -0,0 +1,43 @@ +en: + THEME_LEARN4_GITHUB_EDIT: Edit + THEME_LEARN4_GITHUB_NOTE: "Found errors? Think you can improve this documentation? Simply click the Edit link at the top of the page, and then the icon on Github to make your changes." + THEME_LEARN4_CLEAR_HISTORY: Clear History + THEME_LEARN4_BUILT_WITH_GRAV: Built with Grav - The Modern Flat File CMS + THEME_LEARN4_SEARCH_DOCUMENTATION: Search... + THEME_LEARN4_SEARCH_ADVANCED: Advanced search +cn: + THEME_LEARN4_GITHUB_NOTE: 发现错误?请帮忙改进,谢谢! + THEME_LEARN4_CLEAR_HISTORY: 清除历史 + THEME_LEARN4_BUILT_WITH_GRAV: Built with Grav - The Modern Flat File CMS + THEME_LEARN4_SEARCH_DOCUMENTATION: 搜索文档 +cs: + THEME_LEARN4_GITHUB_NOTE: Našli jste chybu? Myslíte, že můžete vylepšit tuto dokumentaci? + THEME_LEARN4_CLEAR_HISTORY: Smazat historii + THEME_LEARN4_BUILT_WITH_GRAV: Postaveno na Grav - Moderní správce obsahu pomocí souborů prostých textů + THEME_LEARN4_SEARCH_DOCUMENTATION: Vyhledat v dokumentaci +de: + THEME_LEARN4_GITHUB_NOTE: Fehler gefunden? Möchten Sie diese Seite verbessern? + THEME_LEARN4_CLEAR_HISTORY: Verlauf löschen + THEME_LEARN4_BUILT_WITH_GRAV: Seite erstellt mit Grav - The Modern Flat File CMS + THEME_LEARN4_SEARCH_DOCUMENTATION: Dokumentation durchsuchen +es: + THEME_LEARN4_GITHUB_NOTE: ¿Encontraste errores? ¿Crees que puedes mejorar esta documentación? + THEME_LEARN4_CLEAR_HISTORY: Limpiar historial + THEME_LEARN4_BUILT_WITH_GRAV: Hecho con Grav - El CMS moderno de archivos planos + THEME_LEARN4_SEARCH_DOCUMENTATION: Buscar en la documentación +fr: + THEME_LEARN4_GITHUB_NOTE: Vous avez découvert des erreurs ? Vous pensez pouvoir améliorer cette documentation ? + THEME_LEARN4_CLEAR_HISTORY: Effacer l'historique + THEME_LEARN4_BUILT_WITH_GRAV: Créé avec Grav - Le CMS moderne sans base de données + THEME_LEARN4_SEARCH_DOCUMENTATION: Recherche... + THEME_LEARN4_SEARCH_ADVANCED: Recherche avancée +it: + THEME_LEARN4_GITHUB_NOTE: Hai trovato degli errori? Pensi di poter migliorare questa documentazione? + THEME_LEARN4_CLEAR_HISTORY: Cancella Cronologia + THEME_LEARN4_BUILT_WITH_GRAV: Built with Grav - The Modern Flat File CMS + THEME_LEARN4_SEARCH_DOCUMENTATION: Cerca nella Documentatione +ru: + THEME_LEARN4_GITHUB_NOTE: Нашли ошибки? Думаете, что можете улучшить документацию? + THEME_LEARN4_CLEAR_HISTORY: Очистить историю + THEME_LEARN4_BUILT_WITH_GRAV: Сделано на Grav — современной файловой CMS + THEME_LEARN4_SEARCH_DOCUMENTATION: Поиск по документации diff --git a/themes/yunohost-docs/templates/docs.html.twig b/themes/yunohost-docs/templates/docs.html.twig new file mode 100644 index 00000000..d95acaa4 --- /dev/null +++ b/themes/yunohost-docs/templates/docs.html.twig @@ -0,0 +1,20 @@ +{% set body_classes = body_classes ~ ' ' ~ page.header.body_classes %} +{% extends 'partials/base.html.twig' %} + +{% set tags = page.taxonomy.tag %} +{% if tags %} + {% set progress = page.collection({'items':{'@taxonomy':{'category': 'docs', 'tag': tags}},'order': {'by': 'default', 'dir': 'asc'}}) %} +{% else %} + {% set progress = page.collection({'items':{'@taxonomy':{'category': 'docs'}},'order': {'by': 'default', 'dir': 'asc'}}) %} +{% endif %} + +{% block content %} + {% include 'partials/toc.html.twig' %} + + {% include 'partials/page.html.twig' %} + + {% if github_config.note == true %} + {% include 'partials/github-note.html.twig' %} + {% endif %} + +{% endblock %} diff --git a/themes/yunohost-docs/templates/macros/macros.html.twig b/themes/yunohost-docs/templates/macros/macros.html.twig new file mode 100644 index 00000000..9102f785 --- /dev/null +++ b/themes/yunohost-docs/templates/macros/macros.html.twig @@ -0,0 +1,35 @@ +{% macro loop(page, parent_loop) %} + {% import _self as macros %} + {% if parent_loop|length > 0 %} + {% set data_level = parent_loop %} + {% else %} + {% set data_level = 0 %} + {% endif %} + {% for p in page.children.visible %} + {% set parent_page = p.activeChild ? ' parent' : '' %} + {% set current_page = p.active ? ' active' : '' %} +
  • + + + {% if data_level == 0 %}{{ loop.index }}. {% endif %}{{ p.menu }} + + {% if p.children.count > 0 %} +
      + {{ macros.loop(p, parent_loop|default(0)+loop.index) }} +
    + {% endif %} +
  • + {% endfor %} +{% endmacro %} + +{% macro version(p) %} + {% set parent_page = p.activeChild ? ' parent' : '' %} + {% set current_page = p.active ? ' active' : '' %} +
    + {% if p.activeChild or p.active %} + {{ p.menu }} + {% else %} + {{ p.menu }} + {% endif %} +
    +{% endmacro %} diff --git a/themes/yunohost-docs/templates/partials/base.html.twig b/themes/yunohost-docs/templates/partials/base.html.twig index 8ae29117..dadb566b 100644 --- a/themes/yunohost-docs/templates/partials/base.html.twig +++ b/themes/yunohost-docs/templates/partials/base.html.twig @@ -1,3 +1,4 @@ +{% set theme_config = attribute(config.themes, config.system.pages.theme) %} {% set github_config = theme_var('github') %} {% set grid_size = theme_var('grid-size') %} {% set compress = theme_var('production-mode') ? '.min.css' : '.css' %} diff --git a/themes/yunohost-docs/templates/partials/sidebar.html.twig b/themes/yunohost-docs/templates/partials/sidebar.html.twig new file mode 100644 index 00000000..e75d7ef8 --- /dev/null +++ b/themes/yunohost-docs/templates/partials/sidebar.html.twig @@ -0,0 +1,44 @@ +{% import 'macros/macros.html.twig' as macros %} + +
    + +
    +
    +
    + {% if theme_config.top_level_version %} + {% for slug, ver in pages.children %} + {{ macros.version(ver) }} +
      + {% if ver.activeChild or ver.active %} + {{ macros.loop(ver, '') }} + {% endif %} +
    + {% endfor %} + {% else %} +
      + {% if theme_config.root_page %} + {{ macros.loop(page.find(theme_config.root_page), '') }} + {% else %} + {{ macros.loop(pages, '') }} + {% endif %} +
    + {% endif %} +
    + + + {{ 'THEME_LEARN4_CLEAR_HISTORY'|t }} +
    +
    +