Skip to content

Welcome dans la syntaxe mardown

Certainement sans grands interêts pour toi, se trouve ici mes notes par rapport au ajouts et modifications que j'ai pu effectuer sur MkDocs, ainsi que mes notes pour la syntaxe du markdown.

Extensions intallées

Formatage texte

Caret, Mark & Tilde -> Permet de mettre du text en évidance (barré, italique, gras, souligné)
Caret & Tilde -> permet d'utiliser les indices supérieurs et inférieurs H2O ATA
Keyboard keys -> permet d'afficher des raccourcis claviers Ctrl+Alt+Del voir Python Markdown Extensions pour consulter les codes disponiblesn

Mémo markdown

Style et formatage du texte

~Texte barré~~ : 

Voici un ~~texte barré~~

Texte en gras: 

Voici un **texte en gras**

Texte en italique: 

Voici un _texte en italique_

Texte surligné 

Voici un ==texte surligné==

Texte souligné: 

Voici un ^^texte souligné^^

Il est possible combiner les formatages 

Voici un ==^^**_~~texte en gras italique barré surligné et souligné~~_**^^==

fgfgfg.txfght
dfgdsfgssgg   

  ``
  dfsdfsdfsdf
  ``

Boites de code

La documentation officielle est ICI.

Texte seule encadré : 

```Texte seule encadré```


Boite de texte ou code:
 ```
 Boite de texte ou code
 ```

Tips MkDocs

Il est possible de personnaliser le thème à sa convenance. Suivant la documentation, il est conseillé de créer un fichier .css séparé pour mettre les modifications du thème. Pour trouver quel élément du fichier css d'origine au thème agit sur une partie du site, j'utilise simplement les outils de dévéloppeur de mon navigateur.

Augmenter la largeur totale de l'affichage

Créer un nouveau fichier extra.css par exemple dans un dossier stylesheets dans le dossier docs, histoire de classer nos affaires: 

├── docs
│   ├── index.md
│   └── stylesheets
│       └── extra.css
└── mkdocs.yml

Déclarer dans le fichier mkdocs.yml la prise en compte du nouveau fichier css : 

extra_css  
 - stylesheets/extra.css

Ajouter dans le fichier stylesheets.css: 

.md-grid {
  max-width: 70rem;
}

Diminuer l'espace entre le texte et le symbole >

Dans extra_css ajouter le code suivant : 

[dir=ltr] .md-nav_link .md-icon:last-child {
  margin-left: 50px;
}