titre 1lien
syntaxe # titre 1
Title: Here is a title
A->B: Normal line
B-->C: Dashed line
C->>D: Open arrow
D-->>A: Dashed open arrow
vient écraser le titre de la page qui «normalement» ici est celui du menu donc «CheatSheet»
titre 2lien
syntaxe ## titre 2
titre 3lien
syntaxe ## titre 3
etc. jusqu’à six(?) niveau
mises en page & mise en valeur du textelien
ligne et paragraphelien
il suffit de sauter une ligne
…pour changer de paragraphe
En revanche pour
passer à la ligne le retour chariot ne suffit pas
…à moins d’insérer un espace double après le dernier caractère
comme ici
italic, gras, barré, indice, exposantlien
code... notamment pour écrire cette page
code... notamment pour écrire cette page
italique ou italique *italique* ou _italique_
gras ou gras **gras** ou __gras__
barré ~~barré~~
subscript/indice H2O H~2~O
Ces derniers (usage du tilde) nécessitent l’extension ( fichier de config mkdocs.yml)
markdown_extensions:
- pymdownx.tilde
superscript/exposant H2O H^2^O (ajouter - pymdownx.caret dans markdow_extensions:` )
commentaireslien
<!-- commentaire façon html ? -->
…oui, sans les quotes, ça ne s’affiche pas ! ;-)
caractères spéciaux, html, emoticons, fontlien
© ◊ ßbı|Ë|Í ∏ŒŒŸÁ ] : l’utf8 de mon clavier passe sans problème.
portabilité !?
… à éviter car : en dehors des caractères utf8 « simple » ( é à ç etc), les caractères spéciaux tapés ci-dessus entraînent des soucis, notamment les fonctionnalités d’export aux format pdf, LaTeX inclues dans mon markdown-mode (Emacs): les convertisseurs sous-jacents sont … un peu perdus! en fait il y aurait une option pymdownxcommentaire à faire ote: à creur
Sinon le codage html © (©) permet de s’en sortir et même pour
un retour chariot <br> qui force le passage à la ligne ici
ou le double espace avant
retour chariot, « façon markdown » comme décrit plus haut.
smileyslien
:alien: :yum: :confused: :smirk: :kiss: :frog: :fr: :gb: :phone: :tongue: :trollface: :computer:
:phone:
:trollface:
fontawesomelien
là aussi il y a un peu de configuration …ça mérite un :fa-coffee: ou une :fa-beer: !
Il y a un -ée d’ emoticones, voici une liste (partielle?)
:fa-music:
<3 :fa-coffee 3x:
divers : commentaires, ligne horizontalelien
les commentaires:
<!-- commentaire façon html ? -->
…oui, sans les quotes, ça ne s’affiche pas ! ;-)
ligne horizontale
syntaxe: ***
définitions, listes , citations:lien
définition : pratique, liste sans bullet
description
: même erreur en LaTeX où l’on oublie l’existence de l’environnement description
qui prévoit \item[mot en gras]
**définition**
: pratique car évite d'avoir à mettre en **gras** les mots en début
de ligne dans une ligne simple
**description**
: même erreur en LaTeX où l'on oublie l'existence de l'environnement *description*
qui prévoit `\item[mot en gras]`
listes à puces et numérotées :
- item 1
- item 2
- sousitem a
- sousitem b
- sous sous
- sous sous
- item 3
A minima 3 espaces sont nécessaires pour produire la liste imbriquée ci-dessus (noter l’incrémentation auto des liste numérotées (1,2…puis a,b,…puis i,ii,iii,…)
- item 1
- item 2
1. sousitem a
2. sousitem b
1. sous sous
2. sous sous
- item 3
citation :
machin a dit que
> machin a
> dit
> que
(ou voir le dernier bloc ci-dessous)
bloc alertes notelien
la syntaxe est la suivante:
!!! keyword "titre du bloc facultatif ( | keyword alternatif)"
blabla
avec keyword = «note» ( | seealso )
blabla
avec keyword = «tip» ( | hint | important)
blabla
avec keyword = «info» ( | todo)
blabla
avec keyword = «question» ( | help | faq)
blabla
avec keyword = «summary» ( | tdlr )
blabla
avec keyword = «warning» (ou caution ou attention)
blabla
avec keyword = «failure» ( fail | missing )
blabla
avec keyword = «succes» ( check| done)
blabla
avec keyword = «danger» ( | error )
blabla
avec keyword = «bug»
blabla
avec keyword = «quote»
blabla
lienslien
externes:lien
syntaxe: [calculco](https://www-calculco.univ-littoral.fr) : calculco
avec «alt»: [calculco](https://www-calculco.univ-littoral.fr 'le super centrel') : calculco
ou bien (option MagicLink ) : https://www-calculco.univ-littoral.fr
syntaxe : <https://www-calculco.univ-littoral.fr>
internes :lien
syntaxe: [matlab](soft/matlab) matlab (vers une fiche)
syntaxe: [matlab](soft/matlab) matlab ( vers une ancre de la fiche )
lien interne
ici (cf config mkdocs.yml) cela dépend de la
config : use_directory_urls (false or true). les pages md sont
soit compilées en nom_fiche/index.html soit nom_fiche.html
imageslien
syntaxe: 
avec « alt » : 

tableslien
| Left | Center | Right |
| :--------- | :------: | ------: |
| Lorem | *dolor* | `amet` |
| [ipsum](/) | **sit** | |
| Left | Center | Right |
|---|---|---|
| Lorem | dolor | amet |
| ipsum | sit |
(src: http://squidfunk.github.io/mkdocs-material/specimen/)
Remarque: trois tirets suffisent à définir les entêtes, le fichier source peut donc être simplifié (pratique, mais fichier source moins lisible!):
| gauche | centré | alignement à droite |
| :--- | :---: | ---: |
| Lorem ipsum | *dolor* | `amet` |
| [ipsum](/) | **sit** | |
| gauche | centré | alignement à droite |
|---|---|---|
| Lorem ipsum | dolor | amet |
| ipsum | sit |
listingslien
en bloclien
créér un bloc avec un triplet de back quote (avec éventuellement le langage pour la mise en valeur des mots clefs)
```python
def fonction():
blabla
#!/bin/bash
TARGET_DIR=images_pdf
# boucle de conversion des images
for i in *jpg; do
convert $i $TARGET_DIR/${i%jpg}pdf
done
def fonction():
blabla
en ligne (highlights)lien
:::bash for i in *jpg; do blabla; done
ou #!bash for i in *jpg; do blabla; done
ne fonctionne qu’avec l’extension:
http://squidfunk.github.io/mkdocs-material/extensions/pymdown/
Spoilerslien
Avec l’option pymdownx.details et un bloc ??? ou ???+ (pour la version par déployé par défaut)
question : age du capitaine
42
en savoir plus
et des brouettes
Addon PyMDown: LaTeX, Graphe etc.lien
Référence https://squidfunk.github.io/mkdocs-material/extensions/pymdown/ install
pleins d’amélioration possibles dont, pour la gestion de d’emphasize plus ou moins imbriqués ( italique, gras ) etc avec Betterem
ajout fichier mkdown.yml
- pymdownx.betterem:
smart_enable: all
option Critic :
https://facelessuser.github.io/pymdown-extensions/extensions/critic/
S’il y a un commentaire à faire , la syntaxe est:
>
czjqqkd:2
` commentaire à faire `
backslah
\{>> commentaire à faire <<\}
Effectuer une substitution : il ne saitpeut pas jouer au tennis vendredi
ceci est incorrect alors on ajoute cela ici et cela fonctionne aussi dans des blocks :
- item1
- item2
- remplac1
- remplac2
czjqqkd:16*ceci est incorrect*czjqqkd:17 alors on ajoute czjqqkd:18 cela iciczjqqkd:19 et cela fonctionne aussi dans des blocks :
czjqqkd:20
- item1
- item2
czjqqkd:21
czjqqkd:22
- remplac1
- remplac2
czjqqkd:23
LaTeXlien
Ajouts dans mkdocs.yml
pymdownx.arithmatex
extra_javascript:
- 'https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-MML-AM_CHTML'
$$
\frac{n!}{k!(n-k)!} = \binom{n}{k}
$$
En ligne, proba. condit. p(x|y) = \frac{p(y|x)p(x)}{p(y)} ça fonctionne également
En ligne, proba. condit. $p(x|y) = \frac{p(y|x)p(x)}{p(y)}$ ça fonctionne également
diagrammes UML, sequence, ganttlien
cf new 2019, plus bas pour les sources des diagrammes
st=>start: Start:>http://www.google.com[blank]
e=>end:>http://www.google.com
op1=>operation: My Operation
sub1=>subroutine: My Subroutine
cond=>condition: Yes
or No?:>http://www.google.com
io=>inputoutput: catch something...
st->op1->cond
cond(yes)->io->e
cond(no)->sub1(right)->op1
Title: Here is a title
A->B: Normal line
B-->C: Dashed line
C->>D: Open arrow
D-->>A: Dashed open arrow
graph LR
hello --> world
world --> again
again --> hello
pie title Which animals do you prefer as pets?
"Dogs" : 386
"Cats" : 85
"Rabbits" : 53
"Hamsters" : 101
gantt
title A Gantt Diagram
dateFormat YYYY-MM-DD
section Section
A task :a1, 2014-01-01, 30d
Another task :after a1 , 20d
section Another
Task in sec :2014-01-12 , 12d
another task : 24d
gantt
dateFormat YYYY-MM-DD
title Adding GANTT diagram functionality to mermaid
excludes weekends
%% (`excludes` accepts specific dates in YYYY-MM-DD format, days of the week ("sunday") or "weekends", but not the word "weekdays".)
section A section
Completed task :done, des1, 2014-01-06,2014-01-08
Active task :active, des2, 2014-01-09, 3d
Future task : des3, after des2, 5d
Future task2 : des4, after des3, 5d
section Critical tasks
Completed task in the critical line :crit, done, 2014-01-06,24h
Implement parser and jison :crit, done, after des1, 2d
Create tests for parser :crit, active, 3d
Future task in critical line :crit, 5d
Create tests for renderer :2d
Add to mermaid :until isadded
Functionality added :milestone, isadded, 2014-01-25, 0d
section Documentation
Describe gantt syntax :active, a1, after des1, 3d
Add gantt diagram to demo page :after a1 , 20h
Add another diagram to demo page :doc1, after a1 , 48h
section Last section
Describe gantt syntax :after doc1, 3d
Add gantt diagram to demo page :20h
Add another diagram to demo page :48h
new (2019): autres testslien
Séries de test après modifs du mkdoc.yml des pages mkdocs … Usage intensif des admonition block, des _Tab(ulations), et des
SuperFences - diagrammes
SuperFences is like Python Markdown’s fences, but better. Nest fences under lists, admonitions, and other syntaxes. Combine multiple fences together in tabbed groups, and even create special custom fences for content like UML.
```tab=”Source” Title: Here is a title A->B: Normal line B–>C: Dashed line C->>D: Open arrow D–>>A: Dashed open arrow
```sequence tab="Result"
Title: Here is a title
A->B: Normal line
B-->C: Dashed line
C->>D: Open arrow
D-->>A: Dashed open arrow
```tab=”Source 2” Title: Here is a title A->B: Normal line B–>C: Dashed line C->>D: Open arrow D–>>A: Dashed open arrow
```sequence tab="Result 2"
Title: Here is a title
A->B: Normal line
B-->C: Dashed line
C->>D: Open arrow
D-->>A: Dashed open arrow
Highlight Example
tab="Source"
import foo.bar
py3 tab="Output"
import foo.bar
Nth Line Example
tab="Source"
2
4
"""Some file."""
import foo.bar
import boo.baz
import foo.bar.baz
tab="Output" linenums="2 2"
"""Some file."""
import foo.bar
import boo.baz
import foo.bar.baz
Special Line Example
tab="Source"
1
2
3
4
"""Some file."""
import foo.bar
import boo.baz
import foo.bar.baz
tab="Output" hl_lines="1 1 2"
"""Some file."""
import foo.bar
import boo.baz
import foo.bar.baz
```console hl_lines=”1 3” root@condor-ce # yum install htcondor-ce
this is a commentlien
root@condor-ce # condor_ce_trace -d ``` bash tab="Bash"
#!/bin/bash
echo "Hello world!"
``` c tab=”C”
include lien
int main(void) { printf(“Hello world!\n”); }
``` c++ tab="C++"
#include <iostream>
int main() {
std::cout << "Hello world!" << std::endl;
return 0;
}
``` c# tab=”C#” using System;
class Program { static void Main(string[] args) { Console.WriteLine(“Hello world!”); } } ```