MkDocs-SQLite-Console

Mkdocs-SQLite-Console est un plugin pour MkDocs, qui permet d'afficher un IDE SQL (SQLite) permettant d'exécuter du code. Le public visé est essentiellement les enseignants et étudiants : les premiers pourront ainsi placer du code que les seconds pourront exécuter et ainsi voir le résultat de leur requête.

Installation

Installer le plugin avec pip :

pyhton3 -m pip install mkdocs-sqlite-console

Pour accéder à la documentation :

git clone git+https://github.com/Epithumia/mkdocs-sqlite-console.git
cd mkdocs-sqlite-console
pyhton3 -m pip install .[docs]
mkdocs build

Puis dans le dossier docs, activer le plugin dans votre fichier mkdocs.yml:

plugins:
  - search
  - sqlite-console

Note

Si vous n'avez aucune entrée dans la section plugins de votre fichier de configuration, vous voudrez sans doute ajouter le plugin search. MkDocs l'active par défaut s'il n'y a pas d'autres plugins, et dans le cas contraire, MkDocs demande de l'activer explicitement.

Plus d'informations sur les plugins se trouvent dans la documentation MkDocs.

Usage

Voir la section Guide d'utilisation

Licence

Voir la licence

Voir aussi

Plus d'informations sur les templates ici.

Plus d'informations sur les blocs ici.