Ou comment écrire les pages d'aide et de documentation
- Voir les procédures
- Chaque page d’information de l’aide est un fichier d’extension .md dans l’arborescence issue de content/….
- Son contenu est au format Markdown (Plus d’informations Guide de Markdown (Pdf))
- Hugo se charge des conversions des fichiers Markdown en HTML pour obtenir un site statique en production et un site dynamique en développement.
Entête de page
- L’entête de page est décrite entre 2 lignes
+++et+++ - Chaque ligne est composée d’un tag et de sa valeur
<tag> = <valeur>
| Tag | Définition | Valeur par exemple | ||
|---|---|---|---|---|
| title | Titre de la page affichée | |||
| date | Date de création de la page | "2018-08-28T14:54:00" |
||
| id | Modèle de la page issu de l’arborescence layouts/… | "single" |
||
| mathjax | Présence de formules mathématiques dans le texte | true |
||
| tags | Liste des tags ??? | ["theme"] |
||
| categories | Liste des catégories ??? | ["starting"] |
Fonctionnalités
https://sourceforge.net/p/hugo-generator/wiki/markdown_syntax/
Séparer le résumé du site de son contenu
La séquence <!--more--> permet cette scission.
Mettre en commentaire des lignes
Ligne invisible:
[comment]: <> (Ceci est un commentaire interne donc absent du fichier .html)Ligne visible dans le code de la page HTML
<!-- Ceci est un commentaire HTML présent dans le fichier .html généré -->
Mettre en commentaire des zones de textes
Comment {>> <<}
Lorem ipsum dolor sit amet.{>>This is a comment<<}
Highlight+Comment {== ==}{>> <<}
Lorem ipsum dolor sit amet, consectetur adipiscing elit. {==Vestibulum at orci magna. Phasellus augue justo, sodales eu pulvinar ac, vulputate eget nulla.==}{>>confusing<<} Mauris massa sem, tempor sed cursus et, semper tincidunt lacus.
Liens vers des fichiers locaux
[fichier texte][test-txt]Afficher un fichier texte[document Pdf][test-pdf]Afficher un document Pdf
Avec les références
[test-txt]: /fichiers/test.txt "Un fichier au format texte UTF-8"
[test-pdf]: /fichiers/28_08_2018%2015_54_16%20__test.pdf "Un fichier au format Pdf"
Visualisation du code
package main
import "fmt"
func print_hi(name string) {
fmt.Println("Hi, ", name)
}
func main() {
print_hi("Tom")
}
//=> prints 'Hi, Tom' to STDOUT.```markdown
# Titre 1
## Titre 2
### Titre 3
#### Titre 4
```# Heading Level 1
Some test
## Heading Level 2
Some more testSaisir des formules mathématiques
$\sqrt{3x-1}+(1+x)^2$ : $\sqrt{3x-1}+(1+x)^2$
$a*a + b^2$ : $a*a + b^2$
Insérer une image dans le texte
clients/customer-1.png || 2
logo-aide-30.png || 2
logo-aide-30.png || 2
Emoji cheat sheet
Pour le code HTML: https://emojipedia.org/ Pour le code markdown: https://www.webpagefx.com/tools/emoji-cheat-sheet/
😆 🚌 🎢
A classer
Vous trouverez la source de cet article dans le répertoire content/posts.
Pour ajouter un nouvel article, placez un nouveau fichier dans le dossier
content/posts en respectant la nomenclature titre-de-l-article.md et
ajoutez les métadonnées nécessaires dans l’en-tête de page Front Matter.
Jetez un œil au fichier source de cet article pour voir comment ça marche.
Hugo also offers powerful support for code snippets:
```go
package main
import "fmt"
func print_hi(name string) {
fmt.Println("Hi, ", name)
}
func main() {
print_hi("Tom")
}
//=> prints 'Hi, Tom' to STDOUT.
```Check out the Hugo docs for more info on how to get the most out of Hugo. File all bugs/feature requests at Hugo’s GitHub repo. If you have questions, you can ask them on Hugo Community.
{{ hugo.generator }}
??? https://gohugo.io/content-management/formats/
https://sourceforge.net/p/hugo-generator/wiki/markdown_syntax/