Skip to content
Snippets Groups Projects
user avatar
RICO_Octo authored
9515c320
History

NumEcoEval quickstart

Objectif du projet

Ce projet a été instancié pour permettre la mise en place de la documentation de l'offre Dataviz / Superset. Techniquement, la documentation s'appuie sur les GitLab Pages et repose sur des fichiers Markdown.

Le résultat est visible à l'adresse suivante : ds/gd3ia/dataviz_superset sur GitLab pages

Le thème utilisé est material car il offre le meilleur rendu

  • Affichage des pages
  • Affichage de la navigation
  • Recherche possible
  • Affichage des citations (info, warning, etc...)
  • Coloration syntaxique du code
  • Copie en un clic du code
  • Génération du PDF (avec les blocs de code et le accordéons bien restitués)
  • Affichage des éléments accordéon de la FAQ

Il est conseillé d'utiliser le format Markdown au sens strict pour ne pas mélanger du HTML à la syntaxe basique reposant sur les balises suivantes :

Les balises de Titre

# Titre de niveau 1

Titre de niveau 1

## Titre de niveau 2

Titre de niveau 2

### Titre de niveau 3

Titre de niveau 3

Les balises de formatage de texte

**Texte en gras**

Texte en gras

_Texte en italique_

Texte en italique

~~Texte barré~~

Texte barré

> Citations

Citations

Les balises de bloc

`Bloc de code simple`

Bloc de code simple

```json
{
    "objet": "bloc de code",
    "rendu": "coloration syntaxique activée (json)",
    "note": 20
}
```
{
    "objet": "bloc de code",
    "rendu": "coloration syntaxique activée (json)",
    "note": 20
}
 - Elément de la liste
 - Autre élément de la liste
  • Elément de la liste
  • Autre élément de la liste

Ne pas utiliser les listes nuémrotées car mal retranscrites en PDF

| header | header |
| ------ | ------ |
| cell | cell |
| cell | cell |
header header
cell cell
cell cell

Les balises de liens

[texte](url)

texte

 ![texte_image](url_image)

texte_image

Les commentaires

[comment]: <> (1ère ligne de commentaire)
[comment]: <> (2ème ligne de commentaire)
[comment]: <> (3ème ligne de commentaire)