From 009d3f90b1881530bd28003abe83cfc3735882be Mon Sep 17 00:00:00 2001 From: Jieiku Date: Fri, 25 Aug 2023 01:44:50 -0700 Subject: Refactor Documentation, PWA Fix, image shortcodes fix, simplify js script loading --- .gitignore | 1 + README.md | 387 ++++-------------------- config.toml | 23 +- content/blog/_index.fr.md | 5 - content/blog/_index.md | 5 - content/blog/blog-section.fr.md | 29 -- content/blog/blog-section.md | 29 -- content/overview-abridge.fr.md | 65 ----- content/overview-abridge.md | 65 ----- content/overview-abridge/index.fr.md | 452 +++++++++++++++++++++++++++++ content/overview-abridge/index.md | 451 ++++++++++++++++++++++++++++ content/overview-abridge/lighthouse.png | Bin 0 -> 3596 bytes content/overview-code-blocks.fr.md | 3 +- content/overview-code-blocks.md | 3 +- content/overview-embed-streamable.fr.md | 3 +- content/overview-embed-streamable.md | 3 +- content/overview-embed-vimeo.fr.md | 3 +- content/overview-embed-vimeo.md | 3 +- content/overview-embed-youtube.fr.md | 3 +- content/overview-embed-youtube.md | 3 +- content/overview-images/ferris-gesture.png | Bin 6741 -> 6678 bytes content/overview-images/index.fr.md | 3 +- content/overview-images/index.md | 3 +- content/overview-markdown-and-style.fr.md | 20 +- content/overview-markdown-and-style.md | 26 +- content/overview-math.fr.md | 14 +- content/overview-math.md | 8 +- content/overview-rich-content/index.fr.md | 10 +- content/overview-rich-content/index.md | 10 +- content/overview-showdata.fr.md | 29 ++ content/overview-showdata.md | 29 ++ content/pages/about.fr.md | 11 +- content/pages/about.md | 9 +- content/posts/_index.fr.md | 4 - content/posts/_index.md | 4 - content/posts/posts-section.fr.md | 20 -- content/posts/posts-section.md | 20 -- package.json | 6 +- sass/abridge.scss | 9 +- static/android-chrome-192x192.png | Bin 1609 -> 1592 bytes static/android-chrome-512x512.png | Bin 3937 -> 3885 bytes static/apple-touch-icon.png | Bin 1542 -> 1537 bytes static/banner.png | Bin 4582 -> 4536 bytes static/favicon-32x32.png | Bin 397 -> 395 bytes static/js/abridge-nosearch.min.js | 1 - static/js/abridge_nosearch.min.js | 1 + static/js/sw_load.js | 6 +- static/js/sw_load.min.js | 2 +- static/js/theme_button.js | 4 +- static/maskable-x128.png | Bin 816 -> 811 bytes static/maskable-x192.png | Bin 1086 -> 1085 bytes static/maskable-x384.png | Bin 1765 -> 1752 bytes static/maskable-x48.png | Bin 397 -> 394 bytes static/maskable-x512.png | Bin 2618 -> 2564 bytes static/maskable-x72.png | Bin 566 -> 519 bytes static/maskable-x96.png | Bin 671 -> 615 bytes static/maskable_x1024.png | Bin 5454 -> 5144 bytes static/mstile-150x150.png | Bin 1202 -> 1200 bytes static/sw.js | 4 +- static/sw.min.js | 2 +- templates/macros/head.html | 75 ++--- templates/page.html | 2 +- templates/shortcodes/img.html | 2 +- templates/shortcodes/imgswap.html | 4 +- templates/shortcodes/showdata.html | 8 + 65 files changed, 1126 insertions(+), 756 deletions(-) delete mode 100644 content/blog/_index.fr.md delete mode 100644 content/blog/_index.md delete mode 100644 content/blog/blog-section.fr.md delete mode 100644 content/blog/blog-section.md delete mode 100644 content/overview-abridge.fr.md delete mode 100644 content/overview-abridge.md create mode 100644 content/overview-abridge/index.fr.md create mode 100644 content/overview-abridge/index.md create mode 100644 content/overview-abridge/lighthouse.png create mode 100644 content/overview-showdata.fr.md create mode 100644 content/overview-showdata.md delete mode 100644 content/posts/_index.fr.md delete mode 100644 content/posts/_index.md delete mode 100644 content/posts/posts-section.fr.md delete mode 100644 content/posts/posts-section.md delete mode 100644 static/js/abridge-nosearch.min.js create mode 100644 static/js/abridge_nosearch.min.js create mode 100644 templates/shortcodes/showdata.html diff --git a/.gitignore b/.gitignore index 0933679..f90aa0f 100644 --- a/.gitignore +++ b/.gitignore @@ -3,6 +3,7 @@ public themes build storage +node_modules static/demo.html static/tinysearch_engine.js static/tinysearch_engine.d.ts diff --git a/README.md b/README.md index 7dea6c8..7c8adce 100644 --- a/README.md +++ b/README.md @@ -3,9 +3,9 @@ # Abridge Zola Theme -Abridge is a fast and lightweight Zola theme using semantic html, only ~6kb css before the svg icons and syntax highlighting css, no mandatory JS[*](https://github.com/Jieiku/abridge#contributing-and-philosophy), and perfect [Lighthouse](https://pagespeed.web.dev/report?url=abridge.netlify.app), [YellowLabTools](https://yellowlab.tools/), and [Observatory](https://observatory.mozilla.org/analyze/abridge.netlify.app) scores. +A fast, lightweight, and modern [Zola](https://getzola.org) theme utilizing [abridge.css](https://github.com/Jieiku/abridge.css) (a class-light semantic HTML CSS Framework). Perfect [Lighthouse](https://pagespeed.web.dev/report?url=abridge.netlify.app), [YellowLabTools](https://yellowlab.tools/), and [Observatory](https://observatory.mozilla.org/analyze/abridge.netlify.app) scores. Here is a [Zola Themes Benchmarks](https://github.com/Jieiku/zola-themes-benchmarks/blob/main/README.md) Page. -Here is a [Zola Themes Benchmarks](https://github.com/Jieiku/zola-themes-benchmarks/blob/main/README.md) Page. +![Lighthouse Score](https://raw.githubusercontent.com/Jieiku/abridge/master/content/overview-abridge/lighthouse.png) Maintenance of this project is made possible by all the contributors and sponsors. If you'd like to sponsor this project and have your avatar or company logo appear below click here. 💖 @@ -13,19 +13,47 @@ Maintenance of this project is made possible by all the -Dans le répertoire du blog, vous verrez le _index.md: - -```md -+++ -template = "index.html" -paginate_by = 3 -sort_by = "date" -+++ -``` - -Au lieu de index.html, vous pouvez également spécifier archive.html, les deux modèles prennent en charge les sections: - -```md -+++ -template = "archive.html" -+++ -``` diff --git a/content/blog/blog-section.md b/content/blog/blog-section.md deleted file mode 100644 index 71bb0f5..0000000 --- a/content/blog/blog-section.md +++ /dev/null @@ -1,29 +0,0 @@ -+++ -title = "Blog Section" -date = 2021-05-04 -draft = false - -[taxonomies] -categories = ["Features"] -tags = ["config"] -+++ - -You can place your content in content/blog/ instead of content/ this will make post urls example.com/blog/post-title - -In the blog directory you will see the _index.md: - -```md -+++ -template = "index.html" -paginate_by = 3 -sort_by = "date" -+++ -``` - -Instead of index.html you can also specify archive.html, both templates support sections: - -```md -+++ -template = "archive.html" -+++ -``` diff --git a/content/overview-abridge.fr.md b/content/overview-abridge.fr.md deleted file mode 100644 index 388ff69..0000000 --- a/content/overview-abridge.fr.md +++ /dev/null @@ -1,65 +0,0 @@ -+++ -title = "Abridge Zola Thème" -date = 2022-05-17 -updated = 2023-07-21 -draft = false - -[taxonomies] -categories = ["Features"] -tags = ["config"] -+++ - -Abridge est un thème Zola rapide et léger utilisant du HTML sémantique, seulement ~6kb css avant les icônes svg et la coloration syntaxique, pas de JS obligatoire, et des scores parfaits [Lighthouse](https://pagespeed.web.dev/report?url=abridge.netlify.app), [YellowLabTools](https://yellowlab.tools/), et [Observatory](https://observatory.mozilla.org/analyze/abridge.netlify.app) scores. Voici une page [de références des thèmes Zola](https://github.com/Jieiku/zola-themes-benchmarks/blob/main/README.md). - -Pour une configuration rapide, copiez le fichier config.toml du thème abrégé à la racine de votre site zola, cela vous donnera une configuration de base avec toutes les valeurs de configuration utilisées. - -Vous pouvez ensuite modifier ou commenter les valeurs de ce fichier si nécessaire. - -Vous devez également décommenter la ligne #theme = "abridge" dans votre fichier racine zola config.toml. Cela indique à votre site racine zola d'utiliser le thème abrégé dans le dossier des thèmes. - -## Pagination - -Vous pouvez définir le nombre d'éléments qui apparaissent sur la page d'accueil en modifiant `content\_index.md` le fichier et en ajustant `paginate_by = 3` - -## Sass Overrides - -Les variables SCSS abrégées peuvent être remplacées en modifiant `sass\abridge.scss` fichier dans le dossier sass racine de votre projet. - -### Page Width - -```scss -$mw:75%,// largeur maximale -``` - -### Abridge Theme Modes - -```scss -$abridgeMode: "switcher",//valeurs valides : switcher, auto, dark, light -``` - -### Colors and Styles - -Vous pouvez spécifier le modèle de couleur que vous souhaitez utiliser comme base: -```scss -$color: "orange",// modèle de couleur à utiliser/remplacer: orange, blue, blueshade -``` - -Remplacez ensuite les couleurs individuelles si nécessaire: -```scss -/// Dark Colors -$f1d: #ccc,// Font Color Primary -$f2d: #ddd,// Font Color Headers -$c1d: #111,// Background Color Primary -$c2d: #222,// Background Color Secondary -... -``` - -### Footer Social Icons - -Vous devez configurer les icônes sociales que vous prévoyez d'utiliser. (rend la taille du fichier css plus petite) - -Pour les désactiver tous simplement, vous pouvez définir `$enable-icons: false` - -Sinon, activez uniquement les icônes dont vous avez besoin, par exemple pour le courrier que vous définiriez `$icon-mail: true` - -Vous devez ensuite désactiver toutes les icônes que vous n'utilisez pas. diff --git a/content/overview-abridge.md b/content/overview-abridge.md deleted file mode 100644 index e3f0b58..0000000 --- a/content/overview-abridge.md +++ /dev/null @@ -1,65 +0,0 @@ -+++ -title = "Abridge Zola Theme" -date = 2022-05-17 -updated = 2023-07-21 -draft = false - -[taxonomies] -categories = ["Features"] -tags = ["config"] -+++ - -Abridge is a fast and lightweight Zola theme using semantic html, only ~6kb css before svg icons and syntax highlighting, no mandatory JS, and perfect [Lighthouse](https://pagespeed.web.dev/report?url=abridge.netlify.app), [YellowLabTools](https://yellowlab.tools/), and [Observatory](https://observatory.mozilla.org/analyze/abridge.netlify.app) scores. Here is a [Zola Themes Benchmarks](https://github.com/Jieiku/zola-themes-benchmarks/blob/main/README.md) Page. - -For quick setup copy the config.toml from the abridge theme into the root of your zola site, this will give you a base configuration with all config values used. - -You can then edit or comment out the values in this file as necessary. - -You should also uncomment out the line #theme = "abridge" in your root zola config.toml file. This tells your root zola site to use the abridge theme in the themes folder. - -## Pagination - -You can set the number of items that appear on the home page by editing `content\_index.md` file and adjusting `paginate_by = 3` - -## Sass Overrides - -Abridge SCSS variables can be overrided by editing `sass\abridge.scss` file in your project's root sass folder. - -### Page Width - -```scss -$mw:75%,// max-width -``` - -### Abridge Theme Modes - -```scss -$abridgeMode: "switcher",//valid values: switcher, auto, dark, light -``` - -### Colors and Styles - -You can specify which color template you want to use as a base: -```scss -$color: "orange",// color template to use/override: orange, blue, blueshade -``` - -Then override individual colors as needed: -```scss -/// Dark Colors -$f1d: #ccc,// Font Color Primary -$f2d: #ddd,// Font Color Headers -$c1d: #111,// Background Color Primary -$c2d: #222,// Background Color Secondary -... -``` - -### Footer Social Icons - -You should configure which social icons you plan to use. (makes the css file size smaller) - -To simply turn them all off you can set `$enable-icons: false` - -Otherwise enable only the icons you need, eg for mail you would set `$icon-mail: true` - -You should then disable all the icons that you do not use. diff --git a/content/overview-abridge/index.fr.md b/content/overview-abridge/index.fr.md new file mode 100644 index 0000000..8e70eef --- /dev/null +++ b/content/overview-abridge/index.fr.md @@ -0,0 +1,452 @@ ++++ +title = "Abridge Zola Thème" +description = "Abridge est un thème Zola rapide et léger utilisant du HTML sémantique, du CSS léger de classe abridge.css et No Mandatory JS." +date = 2022-05-17 +updated = 2023-07-21 +draft = false + +[taxonomies] +tags = ["Features","Config"] +[extra] +toc = true ++++ + +A fast, lightweight, and modern [Zola](https://getzola.org) theme utilizing [abridge.css](https://github.com/Jieiku/abridge.css) (a class-light semantic HTML CSS Framework). Perfect [Lighthouse](https://pagespeed.web.dev/report?url=abridge.netlify.app), [YellowLabTools](https://yellowlab.tools/), and [Observatory](https://observatory.mozilla.org/analyze/abridge.netlify.app) scores. Here is a [Zola Themes Benchmarks](https://github.com/Jieiku/zola-themes-benchmarks/blob/main/README.md) Page. + +Un thème [Zola](https://getzola.org) rapide, léger et moderne utilisant [abridge.css](https://github.com/Jieiku/abridge.css) (un framework HTML CSS sémantique léger en classe ). Scores parfait [Lighthouse](https://pagespeed.web.dev/report?url=abridge.netlify.app), [YellowLabTools](https://yellowlab.tools/) et [Observatory](https://observatory.mozilla.org/analyze/abridge.netlify.app). Voici une page [Zola Themes Benchmarks](https://github.com/Jieiku/zola-themes-benchmarks/blob/main/README.md). + + +![lighthouse](lighthouse.png) + +## Features + +- [X] Scores parfait [Lighthouse](https://pagespeed.web.dev/report?url=abridge.netlify.app), [YellowLabTools](https://yellowlab.tools/) et [Observatory](https://observatory.mozilla.org/analyze/abridge.netlify.app) +- [X] [Prise en charge des PWA](#pwa-application-web-progressive) (Application Web progressive). +- [X] Tout JavaScript peut être [entièrement désactivé](https://abridge.netlify.app/overview-abridge/#javascript-files). +- [X] Thèmes sombre, clair, automatique et Switcher. (les couleurs peuvent être personnalisées, variables CSS) +- [X] Code [surlignage de la syntaxe](https://abridge.netlify.app/overview-code-blocks/). (les couleurs peuvent être personnalisées, variables CSS) +- [X] Blocs de code numérotés avec [mise en évidence des lignes](https://abridge.netlify.app/overview-code-blocks/#toml). +- [X] Prise en charge multilingue. +- [X] Aide à la recherche. (elasticlunr, tinysearch, cigogne) +- [X] Suggestions de recherche touches de navigation, focus `/`, déplacement `flèche`, sélection `entrée`, fermeture `évasion`. +- [X] Page des résultats de recherche, tapez la requête de recherche, puis appuyez sur `Entrée` ou `cliquez` sur l'icône du bouton de recherche. +- [X] [SEO](#seo-et-balises-d-en-tete) soutien. (Optimisation du moteur de recherche) +- [X] [Pagination](#pagination) avec paginateur numéroté sur index. +- [X] Liens vers les articles précédents et suivants basés sur le titre au bas de l'article. +- [X] Table des matières dans la page Index (liens facultatifs cliquables) +- [X] Blocage des messages récents. (Facultatif) +- [X] Bouton Retour en haut. (utilise uniquement CSS) +- [X] Bouton de copie des blocs de code. +- [X] Lien d’e-mail dans l’obscurcissement du pied de page. (anti-spam) +- [X] [KaTeX](https://katex.org/) soutien. +- [X] [Page d'archives](https://abridge.netlify.app/archive/). +- [x] [Mots clés](https://abridge.netlify.app/tags/). +- [x] Catégories. (similaire aux Tags, désactivés/commentés par défaut) +- [x] Liens vers les icônes sociales dans le pied de page. +- [X] Conception réactive. (mobile d'abord) +- [X] Vidéo Shortcodes: [Youtube](https://abridge.netlify.app/overview-embed-youtube/), [Vimeo](https://abridge.netlify.app/overview-embed-vimeo/), [Streamable](https://abridge.netlify.app/overview-embed-streamable/). +- [X] Médias Shortcodes: [video](https://abridge.netlify.app/overview-rich-content/#video), [img](https://abridge.netlify.app/overview-images/#img-shortcode), [imgswap](https://abridge.netlify.app/overview-images/#imgswap-shortcode), [image](https://abridge.netlify.app/overview-rich-content/#image), [gif](https://abridge.netlify.app/overview-rich-content/#gif), [audio](https://abridge.netlify.app/overview-rich-content/#audio). +- [X] Autre Shortcodes: [showdata](https://abridge.netlify.app/overview-showdata/), [katex](https://abridge.netlify.app/overview-math/#usage-1). + +## Démarrage rapide + +Ce thème nécessite une version {{ showdata(src="https://raw.githubusercontent.com/Jieiku/abridge/master/theme.toml" key="min_version" type="toml") }} ou plus tard de [Zola](https://www.getzola.org/documentation/getting-started/installation/) + +```bash +git clone https://github.com/jieiku/abridge.git +cd abridge +zola serve +# open http://127.0.0.1:1111/ in the browser +``` + +## Installation + +Le démarrage rapide montre comment exécuter le thème directement. Ensuite, nous utiliserons abridge comme thème pour un NOUVEAU site. + +### 1: Créer un nouveau site zola + +```bash +zola init mysite +cd mysite +``` + +### 2: Installer abridge + +Ajoutez le thème en tant que sous-module git : + +```bash +git init # si votre projet est déjà un dépôt git, ignorez cette commande +git submodule add https://github.com/jieiku/abridge.git themes/abridge +``` + +Ou clonez le thème dans votre répertoire de thèmes: + +```bash +git clone https://github.com/jieiku/abridge.git themes/abridge +``` + +### 3: Configuration + +Copiez certains fichiers du répertoire du thème vers le répertoire racine de votre projet: + +```bash +touch templates/.gitkeep +rsync themes/abridge/config.toml config.toml +rsync themes/abridge/content/_index.md content/ +rsync themes/abridge/COPY-TO-ROOT-SASS/* sass/ +rsync themes/abridge/netlify.toml netlify.toml +rsync themes/abridge/package.json package.json +rsync -r themes/abridge/content/static content/ +``` + +- `templates/.gitkeep` le répertoire des modèles est requis dans votre site de base. [#2150](https://github.com/getzola/zola/issues/2150) +- `config.toml` configuration de base avec toutes les valeurs de configuration. +- `content/_index.md` requis pour définir la pagination. +- `COPY-TO-ROOT-SASS/abridge.scss` remplace pour personnaliser les variables Abridge. +- `netlify.toml` paramètres pour déployer votre dépôt avec netlify +- `package.json` pour basculer entre nosearch, elasticlunr, tinysearch, stork. +- `content/static` fichiers pour générer des index tinysearch et stork. + +Décommentez la ligne de thème dans le fichier racine config.toml de votre projet: +```bash +sed -i 's/^#theme = "abridge"/theme = "abridge"/' config.toml +``` + +### 4: Ajouter du nouveau contenu + +Copiez le contenu du répertoire du thème dans votre projet ou créez un nouveau message: + +```bash +rsync -r themes/abridge/content . +``` + +### 5: Exécuter le projet + +Exécutez simplement `zola serve` dans le chemin racine du projet: + +```bash +zola serve +``` + +Zola démarrera le serveur web de développement, accessible par défaut à `http://127.0.0.1:1111`. + +Les modifications enregistrées seront rechargées en direct dans le navigateur. (appuyez sur `ctrl+f5`, ou pendant le développement, définissez `pwa=false` dans `config.toml`) + +## Pagination + +Vous pouvez définir le nombre d'éléments de la page d'accueil en éditant le fichier `content\_index.md` et en ajustant `paginate_by` + +## Remplacements Sass + +Les variables Abridge SASS peuvent être remplacées en éditant le fichier `sass\abridge.scss` dans le dossier sass racine de votre projet. + +### Largeur de page + +```scss +$mw:75%,// largeur maximale +``` + +### Modes thématiques abrégés + +```scss +$abridgeMode: "switcher",//valeurs valides: switcher, auto, dark, light +``` + +- switcher: affiche automatiquement une version sombre ou claire en fonction des paramètres du navigateur/système d'exploitation et dispose d'un sélecteur de thème javascript cliquable par l'utilisateur. +- auto: affiche automatiquement une version sombre ou claire en fonction des paramètres du navigateur/système d'exploitation. +- dark: est toujours le thème sombre. +- light: est toujours le thème de la lumière. + +### Couleurs et styles + +Vous pouvez spécifier le modèle de couleur que vous souhaitez utiliser comme base: +```scss +$color: "orange",// modèle de couleur à utiliser/remplacer: orange, blue, blueshade +``` + +Remplacez ensuite les couleurs individuelles si nécessaire: +```scss +/// Couleurs sombres +$f1d: #ccc,// Couleur de police principale +$f2d: #ddd,// En-têtes de couleur de police +$c1d: #111,// Couleur d'arrière-plan primaire +$c2d: #222,// Couleur d'arrière-plan secondaire +... +``` + +### Icônes sociales de pied de page + +Vous devez configurer les icônes sociales que vous envisagez d'utiliser. (rend la taille du fichier CSS plus petite) + +Pour simplement les désactiver tous, vous pouvez définir `$enable-icons: false` (désactive TOUTES les icônes, la navigation, la recherche, etc.) + +Sinon, activez uniquement les icônes dont vous avez besoin, par exemple pour le courrier que vous définiriez `$icon-mail: true` + +Vous devez ensuite désactiver toutes les autres icônes que vous n'utilisez pas. + +### Thème des visites noscript + +Si vous avez configuré Abridge pour utiliser le mode de commutation au lieu de auto/dark/light, alors votre site aura un bouton qui permettra au visiteur de basculer le thème. + +Si votre visiteur utilise noscript ou un autre module complémentaire de navigateur bloquant Javascript, il sera alors bloqué avec le thème par défaut configuré pour le mode de commutation. + +Pour ajuster ce mode, vous devez définir les deux valeurs de configuration suivantes dans `abridge.scss` **ET** `config.toml`: + +```scss +$switcherDefault: "dark",// mode de commutation nojs par défaut: dark, light (assurez-vous de définir également js_switcher_default dans config.toml) +``` + +```toml +js_switcher_default = "dark" # mode de commutation nojs par défaut: dark, light (assurez-vous de définir également $switcherDefault dans abridge.scss) +``` + +Par défaut, abridge utilise le mode sombre pour le sélecteur, donc à moins que vous ne souhaitiez définir le mode par défaut sur clair pour les visiteurs nojs/noscript, vous n'avez pas à vous soucier de ces paramètres. + +## Config.toml Configuration + +La plupart des options de `config.toml` sont auto-documentées. (évident entre le nom de la valeur de configuration et les commentaires) + +Abridge fonctionnera avec un `config.toml` barebones car les valeurs par défaut sont fournies dans les fichiers modèles. + +Je recommande de copier l'intégralité du fichier config.toml comme indiqué à l'étape 3 car il fournit toutes les valeurs configurables. + +### Menus du haut et du pied de page + +Définissez un champ dans `extra` avec une clé de `menu` et `menu_footer`. +Si vous souhaitez que le lien s'ouvre dans un nouvel onglet/navigateur, définissez `blank = true`. +Si un lien doit avoir une barre oblique à la fin de l'URL définie `slash = true`. +(généralement, tous les liens doivent avoir une barre oblique finale, sauf s'il s'agit d'un lien de fichier tel que `sitemap.xml`) + +```toml +menu = [ + {url = "about", name = "About", slash = true, blank = false}, + {url = "posts", name = "Posts", slash = true, blank = false}, + {url = "categories", name = "Categories", slash = true, blank = false}, + {url = "tags", name = "Tags", slash = true, blank = false}, +] +menu_footer = [ + {url = "about", name = "About", slash = true, blank = false}, + {url = "contact", name = "Contact", slash = true, blank = false}, + {url = "privacy", name = "Privacy", slash = true, blank = false}, + {url = "sitemap.xml", name = "Sitemap", slash = false, blank = true}, +] +``` + +### SEO et balises d’en-tête + +Vous pouvez consulter les balises SEO dans la macro principale située dans `templates/macros/head.html`, toutes les valeurs configurables doivent être dans `config.toml` sous `config.extra` ou dans les fichiers de démarque de contenu. + +Dans votre fichier de démarque, vous devez définir un titre de moins de 60 caractères et une description entre 80 et 160 caractères. La description est ce qui est affiché dans les résultats de recherche sous le titre de la page. Partout où vous ne définissez pas de description de page, le fichier config.description du site principal sera utilisé à la place. + +Vous devez également définir des mots-clés spécifiques à la page, à moins que vos mots-clés définis dans config.toml suffisent, tous les mots-clés que vous ajoutez à la page s'ajoutent à ceux définis dans config.toml, n'ajoutez donc pas ces mêmes mots-clés aux mots-clés de votre page. + +Vous pouvez éventuellement également définir une image spécifique à la page pour les résultats de recherche en utilisant page.extra.thumbnail. Les cartes Facebook, Twitter et OpenGraph sont prises en charge (image et description automatiques pour les liens publiés). OpenGraph recommande 1200 x 630 (1,9:1). Twitter recommande 2:1 pour les grands et 1:1 pour les petits. Si vous ne définissez pas de miniature spécifique à la page, la bannière définie dans config.toml sera utilisée à la place. + +Faire référence à [overview-images](https://raw.githubusercontent.com/Jieiku/abridge/master/content/overview-images/index.md) à titre d'exemple: +```md ++++ +title = "Codes courts d'image" +description = "Les images peuvent être intégrées directement à l'aide de markdown `![Ferris](ferris.svg)`, mais l'utilisation d'un shortcode empêche CLS en définissant explicitement la largeur et la hauteur." +date = 2021-05-19 +draft = false + +[taxonomies] +tags = ["Features","Shortcodes","Images"] +[extra] +toc = true +keywords = "Image, Markdown, Shortcodes, Swap" +thumbnail = "ferris-gesture.png" ++++ +``` + +### Notation mathématique KaTeX + +KaTeX peut être utilisé pour afficher des mathématiques complexes, il s'agit d'une « composition mathématique rapide pour le Web ». + +Vous pouvez voir une démo sur [cette page](https://abridge.netlify.app/overview-math/). + +Pour de meilleures performances, je recommande d'activer uniquement les mathématiques sur une [base par page dans vos fichiers post.md](https://github.com/Jieiku/abridge/blob/master/content/overview-math.md?plain=1#L11-L13), au lieu de dans votre fichier config.toml principal. + +### PWA, application Web progressive + +Le thème Abridge prend en charge PWA. Vous pouvez installer l’intégralité du site en tant qu’application et le faire fonctionner hors ligne. Pour l'essayer, utilisez simplement Google Chrome ou votre téléphone et allez ici: [abridge.netlify.app](https://abridge.netlify.app/) + +Si vous utilisez Chrome sur un ordinateur de bureau, regardez à la fin de la barre d'adresse le bouton d'installation. Sur Android, vous devriez obtenir une fenêtre contextuelle à installer, vous pouvez également installer à partir du menu à 3 points dans le coin supérieur droit. Une fois la PWA installée, vous pouvez vous déconnecter complètement et vous pourrez toujours parcourir ou rechercher sur le site! + +Pour l'utiliser dans votre propre instance, vous devrez éditer `static/sw.js` pour la liste des fichiers à mettre en cache. Techniquement, vous n'avez pas besoin de modifier `sw.js`, mais si même un seul fichier est manquant dans la liste de cache, la liste ne sera pas pré-mise en cache, elle ne sera donc mise en cache que pendant votre navigation. + +Il existe un script npm pour générer la liste de cache de fichiers et la minification `npm run pwa`. Mon fichier `netlify.toml` exécute automatiquement ce script npm lors du déploiement du site, donc tout est automatique. Si Zola était capable de modéliser un fichier js, il serait peut-être possible de générer dynamiquement la liste des fichiers cache lors de la construction. + +La fonctionnalité PWA est également facile à désactiver en définissant simplement `pwa = false` dans `config.toml` + +## Optimisation des performances + +### Fichiers Javascript + +Tout javascript peut être désactivé dans `config.toml`: + +```toml +build_search_index = false + +js_bundle = false +js_copycode = false +js_email_encode = false +js_prestyle = false +js_switcher = false +``` + +Voici les fichiers javascript utilisés par Abridge : + +- search_index.en.js: index de recherche généré par zola à chaque build pour elasticlunr. +- elasticlunr.min.js: bibliothèque de recherche pour la recherche côté client. +- search.js: pour utiliser elasticlunr depuis le champ de recherche de nos sites pour les suggestions et la page de résultats. +- email.js: utilise javascript pour masquer votre véritable adresse e-mail grâce à l'icône de courrier en bas de la page. +- codecopy.js: ajoutez un bouton Copier aux blocs de code, pour copier le contenu du bloc de code dans le presse-papiers. +- theme.js: petit script pour faciliter le stockage local du sélecteur de thème. (jamais groupé, toujours séparé) +- theme_button.js: petit script pour la fonction de changement de thème lorsque vous cliquez sur le bouton de changement de thème. +- prestyle.js: Utilisé pour précharger les fichiers CSS ` + +![lighthouse](lighthouse.png) + +## Features + +- [X] Perfect [Lighthouse](https://pagespeed.web.dev/report?url=abridge.netlify.app), [YellowLabTools](https://yellowlab.tools/), and [Observatory](https://observatory.mozilla.org/analyze/abridge.netlify.app) scores. +- [X] [PWA support](#pwa-progressive-web-app) (Progressive Web Application). +- [X] All JavaScript can be [fully disabled](https://abridge.netlify.app/overview-abridge/#javascript-files). +- [X] Dark, Light, Auto, and Switcher themes. (colors can be customized, css variables) +- [X] Code [syntax highlighting](https://abridge.netlify.app/overview-code-blocks/). (colors can be customized, css variables) +- [X] Numbered code blocks with [line highlighting](https://abridge.netlify.app/overview-code-blocks/#toml). +- [X] Multi-language support. +- [X] Search support. (elasticlunr, tinysearch, stork) +- [X] Search Suggestions navigation keys, `/` focus, `arrow` move, `enter` select, `escape` close. +- [X] Search Results Page, type search query then hit `Enter Key` or `click` the search button icon. +- [X] [SEO](#seo-and-header-tags) support. (Search Engine Optimization) +- [X] [Pagination](#pagination) with numbered paginator on index. +- [X] Title Based Previous and Next Article links at bottom of Article. +- [X] Table of Contents in page Index (Optional, clickable links) +- [X] Recent Posts Block. (Optional) +- [X] Back to Top button. (uses css only) +- [X] Code Blocks copy button. +- [X] Email link in footer obfuscation. (anti-spam) +- [X] [KaTeX](https://katex.org/) support. +- [X] [Archive page](https://abridge.netlify.app/archive/). +- [x] [Tags](https://abridge.netlify.app/tags/). +- [x] Categories. (similar to Tags, disabled/commented out by default) +- [x] Social icon links in footer. +- [X] Responsive design. (mobile first) +- [X] Video Shortcodes: [Youtube](https://abridge.netlify.app/overview-embed-youtube/), [Vimeo](https://abridge.netlify.app/overview-embed-vimeo/), [Streamable](https://abridge.netlify.app/overview-embed-streamable/). +- [X] Media Shortcodes: [video](https://abridge.netlify.app/overview-rich-content/#video), [img](https://abridge.netlify.app/overview-images/#img-shortcode), [imgswap](https://abridge.netlify.app/overview-images/#imgswap-shortcode), [image](https://abridge.netlify.app/overview-rich-content/#image), [gif](https://abridge.netlify.app/overview-rich-content/#gif), [audio](https://abridge.netlify.app/overview-rich-content/#audio). +- [X] Other Shortcodes: [showdata](https://abridge.netlify.app/overview-showdata/), [katex](https://abridge.netlify.app/overview-math/#usage-1). + +## Quick Start + +This theme requires version {{ showdata(src="https://raw.githubusercontent.com/Jieiku/abridge/master/theme.toml" key="min_version" type="toml") }} or later of [Zola](https://www.getzola.org/documentation/getting-started/installation/) + +```bash +git clone https://github.com/jieiku/abridge.git +cd abridge +zola serve +# open http://127.0.0.1:1111/ in the browser +``` + +## Installation + +The Quick Start shows how to run the theme directly. Next we will use abridge as a theme to a NEW site. + +### 1: Create a new zola site + +```bash +zola init mysite +cd mysite +``` + +### 2: Install Abridge + +Add the theme as a git submodule: + +```bash +git init # if your project is a git repository already, ignore this command +git submodule add https://github.com/jieiku/abridge.git themes/abridge +``` + +Or clone the theme into your themes directory: + +```bash +git clone https://github.com/jieiku/abridge.git themes/abridge +``` + +### 3: Configuration + +Copy some files from the theme directory to your project's root directory: + +```bash +touch templates/.gitkeep +rsync themes/abridge/config.toml config.toml +rsync themes/abridge/content/_index.md content/ +rsync themes/abridge/COPY-TO-ROOT-SASS/* sass/ +rsync themes/abridge/netlify.toml netlify.toml +rsync themes/abridge/package.json package.json +rsync -r themes/abridge/content/static content/ +``` + +- `templates/.gitkeep` the templates directory is required in your base site. [#2150](https://github.com/getzola/zola/issues/2150) +- `config.toml` base configuration with all config values. +- `content/_index.md` required to set pagination. +- `COPY-TO-ROOT-SASS/abridge.scss` overrides to customize Abridge variables. +- `netlify.toml` settings to deploy your repo with netlfiy. +- `package.json` to switch between nosearch, elasticlunr, tinysearch, stork. +- `content/static` files for generating tinysearch and stork indexes. + +Uncomment the theme line in your project's root config.toml: + +```bash +sed -i 's/^#theme = "abridge"/theme = "abridge"/' config.toml +``` + +### 4: Add new content + +Copy the content from the theme directory to your project or make a new post: + +```bash +rsync -r themes/abridge/content . +``` + +### 5: Run the project + +Just run `zola serve` in the root path of the project: + +```bash +zola serve +``` + +Zola will start the dev web server, accessible by default at `http://127.0.0.1:1111`. + +Saved changes will live reload in the browser. (press `ctrl+f5`, or while developing set `pwa=false` in `config.toml`) + +## Pagination + +You can set the number of home page items by editing `content\_index.md` file and adjusting `paginate_by` + +## Sass Overrides + +Abridge SASS variables can be overrided by editing `sass\abridge.scss` file in your project's root sass folder. + +### Page Width + +```scss +$mw:75%,// max-width +``` + +### Abridge Theme Modes + +```scss +$abridgeMode: "switcher",//valid values: switcher, auto, dark, light +``` + +- switcher: automatically displays a dark or light version depending on browser/OS settings, and has a javascript user clickable theme switcher. +- auto: automatically displays a dark or light version depending on browser/OS settings. +- dark: is the dark theme always. +- light: is the light theme always. + +### Colors and Styles + +You can specify which color template you want to use as a base: +```scss +$color: "orange",// color template to use/override: orange, blue, blueshade +``` + +Then override individual colors as needed: +```scss +/// Dark Colors +$f1d: #ccc,// Font Color Primary +$f2d: #ddd,// Font Color Headers +$c1d: #111,// Background Color Primary +$c2d: #222,// Background Color Secondary +... +``` + +### Footer Social Icons + +You should configure which social icons you plan to use. (makes the css file size smaller) + +To simply turn them all off you can set `$enable-icons: false` (disables ALL icons, navigation, search, etc.) + +Otherwise enable only the icons you need, eg for mail you would set `$icon-mail: true` + +You should then disable all the other icons that you do not use. + +### Theme for noscript visits + +If you have abridge configured to use the switcher mode instead of auto/dark/light, then your site will have a button that allows the visitor to toggle the theme. + +If your visitor uses noscript or some other javascript blocking browser addon, then they will be stuck with whatever the configured default theme is for the switcher mode. + +To adjust this mode you would set the following two config values in `abridge.scss` **AND** `config.toml`: + +```scss +$switcherDefault: "dark",// default nojs switcher mode: dark, light (make sure to also set js_switcher_default in config.toml) +``` + +```toml +js_switcher_default = "dark" # default nojs switcher mode: dark, light (make sure to also set $switcherDefault in abridge.scss) +``` + +By default abridge uses dark mode for the switcher, so unless you want to set the default mode to light for nojs/noscript visitors, then you do not need to worry about these settings. + +## Config.toml Configuration + +Most Options in `config.toml` are self documenting. (obvious between name of config value and comments) + +Abridge will work with a barebones `config.toml` because default values are provided in the template files. + +I recommend copying the entire config.toml file as outlined in Step 3 as it provides all configurable values. + +### Top and Footer menus + +Set a field in `extra` with a key of `menu` and `menu_footer`. +If you want the link to open in a new tab/browser then set `blank = true`. +If a link should have a trailing slash at the end of the url set `slash = true`. +(generally all links should have a trailing slash unless its a file link such as `sitemap.xml`) + +```toml +menu = [ + {url = "about", name = "About", slash = true, blank = false}, + {url = "posts", name = "Posts", slash = true, blank = false}, + {url = "categories", name = "Categories", slash = true, blank = false}, + {url = "tags", name = "Tags", slash = true, blank = false}, +] +menu_footer = [ + {url = "about", name = "About", slash = true, blank = false}, + {url = "contact", name = "Contact", slash = true, blank = false}, + {url = "privacy", name = "Privacy", slash = true, blank = false}, + {url = "sitemap.xml", name = "Sitemap", slash = false, blank = true}, +] +``` + +### SEO and Header Tags + +You can review the SEO tags in the head macro located at `templates/macros/head.html`, all configurable values should be in `config.toml` under `config.extra` or in the content markdown files. + +In your post markdown file you should set a title less than 60 characters and a description between 80 and 160 characters in length. The description is what is displayed in search results below the page title. Anywhere that you do not set a page description, the primary site config.description will be used instead. + +You should also set page specific keywords unless your keywords defined in config.toml suffice, any keywords that you add to the page are in addition to the ones defined in config.toml, so do not add those same keywords to your page keywords. + +You can optionally also set a page specific image for search results by using page.extra.thumbnail. Facebook, Twitter, and OpenGraph Cards are supported (automatic image & description for posted links). OpenGraph recommends 1200 x 630 (1.9:1). Twitter recommends 2:1 for large and 1:1 for small. If you do not set a page specific thumbnail then the banner defined in config.toml will be used instead. + +Refer to [overview-images](https://raw.githubusercontent.com/Jieiku/abridge/master/content/overview-images/index.md) for an example: +```md ++++ +title = "Image Shortcodes" +description = "Images can be embedded directly using markdown `![Ferris](ferris.svg)`, but using a shortcode prevents CLS by explicitly setting the width and height." +date = 2021-05-19 +draft = false + +[taxonomies] +tags = ["Features","Shortcodes","Images"] +[extra] +toc = true +keywords = "Image, Markdown, Shortcodes, Swap" +thumbnail = "ferris-gesture.png" ++++ +``` + +### KaTeX Math Notation + +KaTeX can be used to display complex mathematics, it is a "Fast math typesetting for the web." + +You can see a demo on [this page](https://abridge.netlify.app/overview-math/). + +For better performance I recommend only enabling math on a [per page bases in your post.md files](https://github.com/Jieiku/abridge/blob/master/content/overview-math.md?plain=1#L11-L13), instead of in your main config.toml file. + +### PWA, Progressive Web App + +Abridge theme has PWA support. You can install the entire site as an app and have it work offline. To try it out simply use google chrome or your phone and go here: [abridge.netlify.app](https://abridge.netlify.app/) + +If using Chrome on desktop then look at the end of the address bar for the install button. On Android you should get a popup to install, you can also install from the 3 dot menu in the top right corner. Once you have the PWA installed, you can go completely offline and you will still be able to browse or search the site! + +To use it in your own instance you will need to edit `static/sw.js` for the list of files to cache. Technically you do not need to edit `sw.js`, but if even a single file in the cache list is missing then it wont pre cache the list, so it will only cache as you browse. + +There is an npm script to generate the file cache list and minification `npm run pwa`. My `netlify.toml` file automatically runs this npm script during site deployment, so everything is automatic. If Zola was able to template a js file then it might be possible to generate the list of cache files dynamically at build. + +The PWA feature is also easy to disable by simply setting `pwa = false` in `config.toml` + +## Performance Optimization + +### Javascript files + +All javascript can be disabled in `config.toml`: + +```toml +build_search_index = false + +js_bundle = false +js_copycode = false +js_email_encode = false +js_prestyle = false +js_switcher = false +``` + +These are the javascript files used by Abridge: + +- search_index.en.js: search index generated by zola at each build for elasticlunr. +- elasticlunr.min.js: search library for client side searching. +- search.js: to make use of elasticlunr from our sites search box for both suggestions and the results page. +- email.js: uses javascript to obfuscate your real email address for the mail icon at the bottom of the page. +- codecopy.js: add a Copy Button to code blocks, to copy contents of the code block to clipboard. +- theme.js: tiny script to facilitate local storage for the theme switcher. (never bundle, always separate) +- theme_button.js: tiny script for the theme switcher function when you click the theme switch button. +- prestyle.js: Used to preload css files ` ``` -## Numéros de ligne, mise en surbrillance +## Numéros de ligne, faits saillants ```html,linenos,hl_lines=5 7-9 @@ -180,18 +179,7 @@ de Rob Pike lors du Gopherfest, le 18 novembre 2015. ## Navs -Le menu principal du site est créé en imbriquant la navigation sous une balise d'en-tête. Reportez-vous au haut de ce site pour un exemple. - -Si la balise de navigation se trouve sous la balise principale au lieu de la balise d'en-tête, les liens auront une bordure : - -
- -
+Le menu principal du site est créé en imbriquant la navigation sous une balise d'en-tête. Reportez-vous au haut de ce site pour un exemple. La navigation est réactive, réduisez la largeur de la page pour la voir en action. ## Formes @@ -262,7 +250,7 @@ Si la balise de navigation se trouve sous la balise principale au lieu de la bal
- +