readme: update for simple doc
This commit is contained in:
parent
3fbbfdfc1a
commit
1b8a6b1d0c
144
README.md
144
README.md
|
@ -2,4 +2,148 @@
|
||||||
|
|
||||||
## Répertoire de code du projet Tyto
|
## Répertoire de code du projet Tyto
|
||||||
|
|
||||||
|
## Comment définir les métas
|
||||||
|
```
|
||||||
|
# Obligatoires uniques
|
||||||
|
title: Titre
|
||||||
|
about: Infos de l'article
|
||||||
|
author: Autheur
|
||||||
|
tags: mots-clé-1,mots-clé-2
|
||||||
|
date: YYYY-MM-DD (AAAA-MM-JJ)
|
||||||
|
|
||||||
|
# Optionnels myltiples
|
||||||
|
link: Nom du lien
|
||||||
|
URL
|
||||||
|
Texte Alternatif
|
||||||
|
|
||||||
|
image: Nom
|
||||||
|
URI
|
||||||
|
Texte Alternatif
|
||||||
|
|
||||||
|
file: Nom du lien
|
||||||
|
URL
|
||||||
|
Texte Alternatif
|
||||||
|
|
||||||
|
brut: Nom
|
||||||
|
URI
|
||||||
|
Texte Alternatif
|
||||||
|
|
||||||
|
abbr: NOM (en majuscule)
|
||||||
|
Définition du NOM
|
||||||
|
nom (forme à afficher dans l'artile (optionnel))
|
||||||
|
|
||||||
|
# Séparateur d'au moins 5 "-" pour définir la fin
|
||||||
|
# des métadonnées d'entête de l'article
|
||||||
|
----------
|
||||||
|
```
|
||||||
|
|
||||||
|
## Comment écrire un article
|
||||||
|
### Titre h1 à h6
|
||||||
|
```
|
||||||
|
#1 Titre 1
|
||||||
|
(
|
||||||
|
Un paragraphe
|
||||||
|
)
|
||||||
|
|
||||||
|
#2 Titre 2
|
||||||
|
```
|
||||||
|
### Paragraphes
|
||||||
|
```
|
||||||
|
( CSS
|
||||||
|
Un paragraphe
|
||||||
|
)
|
||||||
|
```
|
||||||
|
|
||||||
|
### Code Brut
|
||||||
|
```
|
||||||
|
[[ CSS
|
||||||
|
def hello_world():
|
||||||
|
print("Hello")
|
||||||
|
]]
|
||||||
|
```
|
||||||
|
|
||||||
|
### Listes ul/ol
|
||||||
|
```
|
||||||
|
-( CSS
|
||||||
|
= Liste ul
|
||||||
|
== Sous-liste ul
|
||||||
|
=== Sous-sous-liste ul
|
||||||
|
++++ Sous-sous-sous-liste ol
|
||||||
|
+++ Sous-sous-liste ol
|
||||||
|
-)
|
||||||
|
```
|
||||||
|
|
||||||
|
### Citations
|
||||||
|
```
|
||||||
|
(( CSS
|
||||||
|
_cite: autheur
|
||||||
|
_lang: langue
|
||||||
|
_link: lien
|
||||||
|
_year: année ou date YYYY-MM-DD
|
||||||
|
_book: référence
|
||||||
|
(
|
||||||
|
Citation placée dans un paragraphe
|
||||||
|
)
|
||||||
|
))
|
||||||
|
|
||||||
|
(( CSS
|
||||||
|
Citation simple sans référence
|
||||||
|
))
|
||||||
|
```
|
||||||
|
|
||||||
|
### Ancres
|
||||||
|
```
|
||||||
|
>> id
|
||||||
|
(
|
||||||
|
un long paragraphe
|
||||||
|
)
|
||||||
|
(
|
||||||
|
>_ID:Retourner au point d'ancre_<
|
||||||
|
)
|
||||||
|
```
|
||||||
|
|
||||||
|
### Lien vers URL
|
||||||
|
```
|
||||||
|
Voir ce _Nom du lien
|
||||||
|
```
|
||||||
|
|
||||||
|
### Lien vers fichier
|
||||||
|
```
|
||||||
|
Voir ce __Nom du lien
|
||||||
|
```
|
||||||
|
|
||||||
|
### Gras, Strong, italique...
|
||||||
|
```
|
||||||
|
*_très gras_* >>> <strong>
|
||||||
|
+_gras léger_+ >>> <b>
|
||||||
|
/_en italique_/ >>> <em>
|
||||||
|
\_en italique_\ >>> <i>
|
||||||
|
~_texte barré_~ >>> <del>
|
||||||
|
<_Code_> ou (_Code_) >>> <code>
|
||||||
|
=_Citation rapide_= >>> <cite>
|
||||||
|
×_Classe personnalisée_× >>> <span class="custom">
|
||||||
|
-_Souligné_- >>> <u>
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
### Abréviations
|
||||||
|
```
|
||||||
|
# NOM sera remplacé par nom si défini en entête
|
||||||
|
# <abbr title="Définition du NOM">nom</abbr>
|
||||||
|
Avec ce NOM.
|
||||||
|
```
|
||||||
|
|
||||||
|
### Images
|
||||||
|
```
|
||||||
|
_image:NOM
|
||||||
|
_image:NOM c=CSS
|
||||||
|
_image:NOM c=CSS w=1080
|
||||||
|
_image:NOM w=640em h=480em
|
||||||
|
_image:NOM t= <<< Rend l'image interne cliquable
|
||||||
|
_image:NOM t=https://...
|
||||||
|
```
|
||||||
|
|
||||||
|
### Code Brut depuis un fichier
|
||||||
|
```
|
||||||
|
_brut:NOM
|
||||||
|
```
|
||||||
|
|
Loading…
Reference in New Issue