klmp200/Sith
1
0
Fork 0
mirror of https://github.com/ae-utbm/sith.git synced 2025-07-11 20:39:23 +00:00
Code Issues Packages Projects Releases Wiki Activity

core: add test for Markdown syntax

Browse Source 
Signed-off-by: Skia <skia@libskia.so>
This commit is contained in:
Skia
2017-08-24 16:29:40 +02:00
parent 30f650ecce
commit 0d5595c683
8 changed files with 350 additions and 56 deletions
Download Patch File Download Diff File Expand all files Collapse all files

91
doc/SYNTAX.md
View File

@ -2,6 +2,15 @@ Cette page vise à documenter la syntaxe *Markdown* utilisée sur le site.
# Markdown-AE Documentation
Le Markdown le plus standard se trouve documenté ici:
https://daringfireball.net/projects/markdown/syntax .
Si cette page n'est pas exhaustive vis à vis de la syntaxe du site AE,
elle a au moins le mérite de bien documenter le Markdown original.
Le réel parseur du site AE est une version tunée de [mistune](https://github.com/lepture/mistune).
Les plus aventureux pourront aller lire ses [tests](https://github.com/lepture/mistune/blob/master/tests/fixtures)
afin d'en connaître la syntaxe le plus finement possible.
En pratique, cette page devrait déjà résumer une bonne partie.
## Basique
@ -13,10 +22,11 @@ Cette page vise à documenter la syntaxe *Markdown* utilisée sur le site.
* ~~Barrer du texte~~ : `~~texte~~`
* ^Mettre du texte^ en ^exposant : `^mot` ou `^texte^`
* On peut bien sûr tout ~~***__combiner__***~~ : `~~***__texte__***~~`
* _Mettre du texte_ en _indice : `_mot` ou `_texte_`
* <sup>Mettre du texte</sup> en exposant : `<sup>texte</sup>`
* <sub>Mettre du texte</sub> en indice : `<sub>texte</sub>`
## Liens
@ -30,9 +40,9 @@ http://www.site.com
[nom du lien](http://www.site.com)
* Les liens peuvent être internes au site de l'AE, on peut dès lors éviter d'entrer
l'adresse complète d'une page : `[nom du lien](article://nomDeLaPage)`
l'adresse complète d'une page : `[nom du lien](page://nomDeLaPage)`
[nom du lien](article://nomDeLaPage)
[nom du lien](page://nomDeLaPage)
* On peut également utiliser une image pour les liens :
`[nom du lien]![images/imageDuSiteAE.png](/chemin/vers/image.png titre optionnel)(options)`
@ -58,6 +68,14 @@ etc...
Si le titre de votre section commence par un tilde (~) alors le texte sous la section est
affiché par défaut caché et il est consultable grace à un bouton +/-
## ~Test
## Paragraphes et sauts de ligne
Un nouveau paragraphe se fait avec deux retours à la ligne.
Un saut de ligne se force avec au moins deux espaces en fin de ligne.
## Listes
@ -81,7 +99,13 @@ Vous pouvez marquer plus simplement comme suit, les numéros se faisant tout seu
1. élément
```
1. élément
1. élément
1. élément
* non ordonnées :
```
* élément
* élément
@ -94,7 +118,7 @@ Vous pouvez marquer plus simplement comme suit, les numéros se faisant tout seu
## Tableaux
Un tableau est obtenu en respectant la syntax suivante :
Un tableau est obtenu en respectant la syntaxe suivante :
```
| Titre | Titre2 | Titre3 |
@ -107,25 +131,42 @@ Un tableau est obtenu en respectant la syntax suivante :
| test | test | test |
| test | test | test |
L'alignement dans les cellules est géré en mettant des espaces à droite ou a gauche des chaines de caractères contenues dans chaque case.
L'alignement dans les cellules est géré comme suit, avec les ':' sur la ligne en dessous du titre:
```
| Titre | Titre2 | Titre3 |
|-------|--------|--------|
|gauche | centre | droite|
| Titre | Titre2 | Titre3 |
|:-------|:------:|-------:|
| gauche | centre | droite |
```
| Titre | Titre2 | Titre3 |
|-------|--------|--------|
|gauche | centre | droite|
| Titre | Titre2 | Titre3 |
|:-------|:------:|-------:|
| gauche | centre | droite |
## Images et contenus
Une image est insérée ainsi : `![texte alternatif](/chemin/vers/image.png "titre optionnel")(options)`
![texte alternatif](/static/core/img/logo.png "titre optionnel")(options)
Une image est insérée ainsi : `![texte alternatif](/chemin/vers/image.png "titre optionnel")`
![texte alternatif](/static/core/img/logo.png "titre optionnel")
On peut lui spécifier ses dimensions de plusieurs manières:
```
![image à 50%](/static/core/img/logo.png?50% "Image à 50%")
![image de 350 pixels de large](/static/core/img/logo.png?350 "Image de 350 pixels")
![image de 350x100 pixels](/static/core/img/logo.png?350x100 "Image de 350x100 pixels")
```
![image à 50%](/static/core/img/logo.png?50% "Image à 50%")
Image à 50% de la largeur de la page.
![image de 350 pixels de large](/static/core/img/logo.png?350 "Image de 350 pixels")
Image de 350 pixels de large.
![image de 350x100 pixels](/static/core/img/logo.png?350x100 "Image de 350x100 pixels")
Image de 350x100 pixels.
( devrait pouvoir détecter si vidéo ou non )
( TODO : parametres )
## Blocs de citations
@ -142,7 +183,26 @@ Un bloc de citation se crée ainsi :
Il est possible d'intégrer de la syntaxe Markdown-AE dans un tel bloc.
## Note de bas de page
On les créer comme ça[^key]:
[^key]: ceci est le contenu de ma clef
```
Je fais une note[^clef].
[^clef]: je note ensuite ou je veux le contenu de ma clef qui apparaîtra quand même en bas
```
Vous pouvez utiliser des numéros pour nommer vos clef si vous avez la flemme.
```
Note plus complexe[^1]
[^1]:
je peux même faire des blocks
sur plusieurs lignes, comme d'habitude!
```
## échapper des caractères
@ -160,3 +220,4 @@ Il est possible d'intégrer de la syntaxe Markdown-AE dans un tel bloc.
> ((note))