Outils de documentation

Asciinema permet d'enregistrer des sessions de terminal, de les envoyer automatiquement en ligne, de les enregistrer localement ou de les rejouer dans une page web avec un lecteur approprié :

Sur linux, il est installable depuis les dépôts sudo apt install asciinema

Si nécessaire, il est possible de transformer ces enregistrements en gif, en svg animé ou en vidéo

Objectif : créer un fichier pdf avec des liens cliquables à partir de la liste de liens sous forme de fichier texte.

Animation à partir de dessins vectoriels au format svg, exportables sous forme de suite d'image, par exemple pour être assemblées en vidéo ou en gif.

https://github.com/gweltou/SgAnimator

Adapté aux animations mathématiques. Les animations sont créées par des scripts python et exportées en vidéo mp4

Carnet de notes permettant d'inclure différents types de cellules (calcul, visualisation) : https://observablehq.com/

Application en ligne avec de nombreux types de visualisation : https://app.rawgraphs.io/

Outils basé sur openstreetmap pour créer des cartes interactives (avec marqueurs, polygones, bulles au contenu multimedia, fonds de carte personnalisables, etc.)
Les cartes peuvent être intégrées à une page web ou sont directement accessibles par une URL.

https://umap.openstreetmap.fr/fr/

Bibliothèque javascript, à réserver aux codeu/r/se/s

https://leafletjs.com/

Plusieurs possibilités, et il y en a sûrement d'autres…

Il existe aussi des thèmes intégrables dans des CMS :

Une page ressource très complète sur dokuwiki : https://dvillers.umons.ac.be/wiki/floss:dokuwiki

Présentations / slides avec marp:

Graphes / diagrammes / visualisation de données avec mermaid : https://mermaid.js.org/intro/
On peut écrire du code mermaid dans codium (ou vscode) grâce au plugin markdown extended
Ensuite on peut en faire le rendu dans l'éditeur web : https://mermaid-js.github.io/mermaid-live-editor
Il existe d'autres éditeurs web mais c'est celui-ci qui m'a donné les meilleurs résultats d'interprétation et le svg le plus léger

Cartes mentales avec markmap

Avec codimd : https://codimd.apps.education.fr/KsjwIfUJT8S8X0gs3lsMIA?both#

Passer de dokuwiki à markdown à mediawiki à pdf, etc.
→ avec Pandoc, installable ou en ligne : https://pandoc.org/try/

Produire un pdf avec coloration syntaxique, en ligne : https://extensions.libreoffice.org/en/extensions/show/code-highlighter

Il existe aussi une extension pour libreoffice : https://nsspot.herokuapp.com/code2pdf/ (pour java : xcode sur fond blanc très bien)

Pour de grandes lettres composées de caractère ASCII : http://www.jave.de/ avec aussi des fonctions de dessin

  • ressource/logiciel/outils_documentation.txt
  • Dernière modification: 2024/07/04 19:02
  • par emoc