From 0f0301b3b70636a9a41e0dd390e8941c32e27566 Mon Sep 17 00:00:00 2001 From: Christophe Chaudier <christophe@lydra.fr> Date: Thu, 10 Feb 2022 18:13:58 +0100 Subject: [PATCH] fix: markdown typos --- README.md | 52 ++++++++++++++++++------------------ README_theme.md | 70 +++++++++++++++++++++++++++++++------------------ 2 files changed, 69 insertions(+), 53 deletions(-) diff --git a/README.md b/README.md index 525ecfc..ed7276f 100644 --- a/README.md +++ b/README.md @@ -1,131 +1,128 @@ # Community-theme -## Plugins + +## Prérequis + +### Plugins + Ce thème utilise les plugins ci-dessous, pensez à les installer avant d'installer ce thème. -### One year anniversary +#### One year anniversary Lors des un an de votre post, recevez une notification pour repartager celui-ci à votre communauté. - Doc : https://meta.discourse.org/t/discourse-yearly-review-plugin/105713 - Dépôt : https://github.com/discourse/discourse-yearly-review -### Reaction +#### Reaction Ajoutez des émojis et participez de façon dynamique aux conversations. - Doc : https://meta.discourse.org/t/discourse-reactions-beyond-likes/183261 - Dépôt : https://github.com/discourse/discourse-reactions - -### Private topic to discover +#### Private topic to discover Vos contenus sont visibles partiellement : encouragez vos contacts à s'inscrire sur la plateforme pour voir la totalité des contenus. - Doc : https://meta.discourse.org/t/advertise-activity-in-a-private-category-discourse-category-lockdown/70649https://github.com/paviliondev/discourse-category-lockdown - Dépôt : https://github.com/paviliondev/discourse-category-lockdown -### Problème du topic réglé +#### Problème du topic résolu Indiquez à une communauté le statut "résolu" d'un problème. - Doc : https://www.discourse.org/plugins/solved.html - Dépôt : https://github.com/discourse/discourse-solved -### Automatisation (ex: for event) +#### Automatisation (ex: for event) Automatisez des actions complexes (version beta). - Doc : https://meta.discourse.org/t/discourse-automation/195773 - Dépôt : https://github.com/discourse/discourse-automation -### Follower +#### Follower Suivez, recevez des notifications de vos membres préférés et tenez vous au courant du nombre de followers. - Doc : https://meta.discourse.org/t/follow-plugin/110579 - Dépôt : https://github.com/discourse/discourse-follow -### Calendrier +#### Calendrier Partagez des événement avec les autres membres sur votre calendrier, ou passez en mode "vacances". - Doc : https://meta.discourse.org/t/discourse-calendar/97376 - Dépôt : https://github.com/discourse/discourse-calendar -### map and post +#### map and post Ajoutez votre géolocalisation sur vos post, ceux-ci peuvent favoriser les recherches entre membres. - Doc : https://meta.discourse.org/t/locations-plugin/69742 - Dépôt : https://github.com/paviliondev/discourse-locations -### Location plugin +#### Location plugin Découvrez la carte des membres de votre communauté et organisez des événements avec les membres les plus proches. - Doc : https://meta.discourse.org/t/locations-plugin/69742/723 - Dépôt : https://github.com/discourse/discourse-calendar - -## Composants +### Composants Ce thème utilise les composants ci-dessous, pensez à les installer avant d'installer ce thème. -### Icônes pour les catégories +#### Icônes pour les catégories Les catégories sont affichées avec des icônes complétant les titres. - Doc : https://meta.discourse.org/t/category-icons-component/104683 - Dépôt : https://github.com/discourse/discourse-category-icons - -### Discourse loading slider +#### Discourse loading slider Une barre horizontale s'affiche lors du temps de chargement d'une page. - Doc : https://meta.discourse.org/t/experiment-on-meta-horizontal-loading-slider/177939 - Dépôt : https://github.com/discourse/discourse-loading-slider - -### Discourse category banners +#### Discourse category banners Affiche une barre de catégorie en haut de la page catégorie. - Doc : https://meta.discourse.org/t/discourse-category-banners/86241 - Dépôt : https://github.com/discourse/discourse-category-banners.git - -### Discourse search banner +#### Discourse search banner Affiche une barre de recherche sur la page d'accueil. - Doc : https://meta.discourse.org/t/search-banner-theme-component/122939 - Dépôt : https://github.com/discourse/discourse-search-banner.git +#### Easy footer -### Easy footer - -Ajoute _footer_ simple et responsive. +Ajoute un _footer_ simple et responsive. - Doc : https://meta.discourse.org/t/easy-responsive-footer/95818 - Dépôt : https://github.com/discourse/Discourse-easy-footer - -### Icons header +#### Icons header Permet d'ajouter des liens sur la partie "header" de votre site avec des icones. - Doc : https://meta.discourse.org/t/custom-header-links-icons/86307 - Dépôt : https://github.com/discourse/discourse-icon-header-links -### MD Topic list +#### MD Topic list Épuration de la partie page d'accueil en améliorant la charte initiale. - Doc : https://meta.discourse.org/t/md-topic-list-component/117694 - Dépôts : https://github.com/MonDiscourse/md-topic-list -### TOC, Table of content +#### TOC, Table of content Ajoute la table des matière du post. @@ -133,6 +130,7 @@ Ajoute la table des matière du post. - Dépôts : https://github.com/discourse/DiscoTOC.git ## Licence + [](https://choosealicense.com/licenses/gpl-3.0/) **community-theme** is maintained by [Lydra](https://lydra.fr/) and released under the GPL3 license. diff --git a/README_theme.md b/README_theme.md index adae016..36a02e2 100644 --- a/README_theme.md +++ b/README_theme.md @@ -1,69 +1,87 @@ # Configuration du thème et des composants + ### Comment ça marche ? #### Thème de base -Nous utilisons le thème <strong>*Mint*</strong> qui reprend les composants <strong>*discourse-search-banner*</strong> et <strong>*Showcased Categories*</strong>. -Nous avons apporté quelques modifications au thème <strong>*Mint*</strong>, afin d'en retirer des formes de décoration et le <strong>*discourse-search-banner*</strong>, ainsi qu'y mettre nos tons colorimétriques et certaines modifications liées aux composants. -<strong>Trois composants sont utilisés dans notre thème principal :</strong> +Nous utilisons le thème **_Mint_** qui reprend les composants **_discourse-search-banner_** et **_Showcased Categories_**. +Nous avons apporté quelques modifications au thème **_Mint_**, afin d'en retirer des formes de décoration et le **_discourse-search-banner_**, ainsi qu'y mettre nos tons colorimétriques et certaines modifications liées aux composants. + +**Trois composants sont utilisés dans notre thème principal :** + +- _Versatile Banner_ +- _Categories boxes_ +- _Showcased Categories_ -#### Bannière "How to begin ?" -D'après le composant <strong>*Versatile Banner*</strong>, nous récupérons les images d'après un url dans un groupe privée, accessible uniquement par l'admin *(pour plus d'info., voir ce lien https://meta.discourse.org/t/upload-image-in-discourse/141504/4)*. +#### Bannière _How to begin ?_ + +D'après le composant **_Versatile Banner_**, nous récupérons les images d'après un url dans un groupe privée, accessible uniquement par l'admin ([plus d'info. ici](https://meta.discourse.org/t/upload-image-in-discourse/141504/4)). - Doc : https://meta.discourse.org/t/versatile-banner/109133 - Dépôt : https://github.com/tshenry/discourse-versatile-banner.git + ##### Configuration + - Possibilité d'afficher cette fonctionnalité à tout le monde ou à un type d'utilisateur : membres, inconnus. - Afficher la bannière sur les appareils mobiles, ordinateurs. - Afficher la bannière sur la page d'accueil. -- Modification des images, des titres, sous-titres et textes, ainsi que du nombre de boxe (4 max). +- Modification des images, des titres, sous-titres et textes, ainsi que du nombre de boxe (4 max). - Choix des pages où apparaîtra la bannière. - Autoriser les utilisateurs à masquer la bannière. - Mettre un fond derrière les images. -- Changer les couleurs du texte. +- Changer les couleurs du texte. + +##### Notre configuration de base -##### Notre configuration de base : La bannière est inclue dans le thème. La bannière s'affiche pour tout le monde et il est possible de la masquer mais pas de l'enlever. -Elle apparaît sur les pages : -/latest -/categories -/new -/unread -/top* -/tag/* -/tags/* -/c/* -/t/* +Elle apparaît sur les pages : + +- `/latest` +- `/categories` +- `/new` +- `/unread` +- `/top*` +- `/tag/*` +- `/tags/*` +- `/c/*` +- `/t/*` Il n'y a pas de fond ni d'image de fond, il est néanmoins possible d'en ajouter. Ensuite on ajoute le contenu de la bannière : texte, images dans chaque colonnes. -Afin d'ajouter une image dans la bannière, il faut récupérer son lien URL. Pour se faire, on créer un post avec une image dans la catégorie staff (privée). Le post ainsi créée, on affiche l'image et on y fait un clic droit pour "copier le lien de l'image". Puis, coller ce lien dans la page configuration du composant, section <strong>*Column Icons*</strong>. +Afin d'ajouter une image dans la bannière, il faut récupérer son lien URL. Pour se faire, on créer un post avec une image dans la catégorie staff (privée). Le post ainsi créée, on affiche l'image et on y fait un clic droit pour "copier le lien de l'image". Puis, coller ce lien dans la page configuration du composant, section `Column Icons`. Voir la page suivante : https://meta.discourse.org/t/upload-image-in-discourse/141504 --- #### Categories boxes -Nous partons du html du composant <strong>*Categories Layout Override*</strong>, et utilisons le scss d'un autre lien. + +Nous partons du html du composant **_Categories Layout Override_**, et utilisons le scss d'un autre lien. + - Doc Categories layout override : https://meta.discourse.org/t/categories-layout-override/131098 - Dépôt : https://github.com/tshenry/discourse-categories-layout-override - - Doc et code scss : https://meta.discourse.org/t/how-to-change-categories-style/78067/14 Note : Des modifications ont été réalisé dans le scss. -##### Notre configuration de base : -Les titres et sous-titres ne sont pas affichés grace à l'option category-boxe, et nous gardons uniquement les images et les titres des topics. +##### Notre configuration de base + +Les titres et sous-titres ne sont pas affichés grace à l'option `category-boxe`, et nous gardons uniquement les images et les titres des topics. --- #### Category post -Le composant <strong>*Showcased Categories*</strong> s'adapte d'office au thème général du forum. + +Le composant **_Showcased Categories_** s'adapte d'office au thème général du forum. + - Doc : https://meta.discourse.org/t/showcased-categories-theme-component/173524 - Dépôt : https://github.com/discourse/discourse-showcased-categories.git + ##### Configuration -Définir le thème de ce que constitura les deux boîtes. On défini la taille maximum du contenu des boîtes et de son contenu : Latest et Top. + +Définir le thème de ce que constitura les deux boîtes. On défini la taille maximum du contenu des boîtes et de son contenu : _Latest_ et _Top_. --- #### Configuration générale après installation du thème -Par défaut, des couleurs ont été appliqué mais vous pouvez les modifier votre palette de couleurs dans <strong>Customize / Colors.</strong> Pour faire valider le thème, celui-ci doit être votre <strong>thème par défaut.</strong> Dans la section <strong>*Included Components*</strong>, vous pouvez cliquer sur <strong>*Add all*</strong> ou bien n'en mettre que certains. + +Par défaut, des couleurs ont été appliqué mais vous pouvez les modifier votre palette de couleurs dans `Customize / Colors`. Pour faire valider le thème, celui-ci doit être votre **thème par défaut.** Dans la section `Included Components`, vous pouvez cliquer sur `Add all` ou bien n'en mettre que certains. -- GitLab