From 1ef4be942e5ab3211f7a9afd972f8de0b67a0688 Mon Sep 17 00:00:00 2001 From: tituspijean Date: Sun, 11 Jul 2021 21:58:07 +0200 Subject: [PATCH] Add smartypants extension to enhance typography --- config/plugins/smartypants.yaml | 10 ++++++++++ .../write_documentation.fr.md | 15 ++++++++++++--- .../02.write_documentation/write_documentation.md | 9 +++++++++ 3 files changed, 31 insertions(+), 3 deletions(-) create mode 100644 config/plugins/smartypants.yaml diff --git a/config/plugins/smartypants.yaml b/config/plugins/smartypants.yaml new file mode 100644 index 00000000..7dd0f2d6 --- /dev/null +++ b/config/plugins/smartypants.yaml @@ -0,0 +1,10 @@ +enabled: true +twig_filter: true +enabled_in_admin: false +process_title: true +process_content: true +options: qDewgf +dq_open: “ +dq_close: ” +sq_open: ‘ +sq_close: ’ diff --git a/pages/04.contribute/02.write_documentation/write_documentation.fr.md b/pages/04.contribute/02.write_documentation/write_documentation.fr.md index 7249951e..a6c84ab0 100644 --- a/pages/04.contribute/02.write_documentation/write_documentation.fr.md +++ b/pages/04.contribute/02.write_documentation/write_documentation.fr.md @@ -27,14 +27,17 @@ La structure du dépôt est décrite ici: +-- config +-- site.yaml +-- system.yaml + +-- plugins + # Contient les fichiers de configuration des plugins. + # Attention, ne partagez pas d'information sensible ou des identifiants. +-- themes +-- yunohost-docs.yaml # Quelques paramètres pour le thème de la documentation +-- images - # Contains the images used in the documentation pages. + # Contient les images utilisées dans la documentation +-- pages - # The directory containing the documentation pages. - # The pages hierarchy is reflected by the directory hierarchy. + # Le dossier contenant les pages de la documentation + # La hiérarchie entre les pages est gouvernée par celle entre les dossiers. +-- 00.home +-- 01.administrate +-- 02.applications @@ -90,8 +93,13 @@ markdown-notices presentation presentation-deckset shortcode-core +smartypants ``` +!!! L'extension `smartypants` se charge de remplacer automatiquement les apostrophes `'` et guillemets `"` +!!! par leurs équivalents typographiquement corrects, `’`, `“` et `”`. +!!! Les guillemets « et » peuvent être obtenus ainsi : `<< et >>`. Notez les espaces. + ## Pages spéciales Quelques pages de la documentation sont générées automatiquement ou dynamiquement. @@ -123,6 +131,7 @@ markdown-notices presentation presentation-deckset shortcode-core +smartypants tntsearch ``` 3. Paramétrez l'extension Git Sync. diff --git a/pages/04.contribute/02.write_documentation/write_documentation.md b/pages/04.contribute/02.write_documentation/write_documentation.md index 504dd161..582113f4 100644 --- a/pages/04.contribute/02.write_documentation/write_documentation.md +++ b/pages/04.contribute/02.write_documentation/write_documentation.md @@ -28,6 +28,9 @@ The structure of the repository is described below: +-- config +-- site.yaml +-- system.yaml + +-- plugins + # Contains configuration files for the plugins. + # Be careful, do NOT share sensitive information and credentials. +-- themes +-- yunohost-docs.yaml # Some settings for the documentation theme @@ -91,8 +94,13 @@ markdown-notices presentation presentation-deckset shortcode-core +smartypants ``` +!!! `smartypants` extension takes care of replacing apostrophes, single `'` and double `"` quotation marks +!!! by their typographically correct relatives `’`, `“` and `”`. +!!! French quotation marks « and » can be obtained like this `<< and >>`. Note the spaces. + ## Special pages Some pages of the documentation are automatically or dynamically generated. @@ -124,6 +132,7 @@ markdown-notices presentation presentation-deckset shortcode-core +smartypants tntsearch ``` 3. Set-up Git Sync plugin.