Création de documentation

Logiciels et multimédia
  • Petit billet du samedi matin (faudrait pas prendre ça pour habitude 😉 )
    '========================================================='
    Hello, suite au message de @papinou concernant le passage progressif du code kernel du noyau Linux vers le langage Rust, je suis allé faire mon premier "hello world" en Rust. Comme quoi, les publications des uns et des autres servent bien à quelque chose ! J'ai alors trouvé que la documentation concernant Rust était fort bien faite (https://jimskapt.github.io/rust-book-fr/). J'ai alors farfouiné pour voir avec quel système cette doc avait été faite. Il s'agit d'un système appelé "MdBook" (Markdown book). Je vous laisse le lien pour créer vos propres documentations (en anglais malheureusement, pas vu de traduction). J'ai essayé de faire mes premières pages et ça fonctionne bien (à priori) :
    https://rust-lang.github.io/mdBook/index.html
    Les pages sont à écrire en langage Markdown, un langage assez simple pour faire des pages de doc en général et qui commence à prendre de l'ampleur un peu partout (bon rapport simplicité/fonctionnalité).
    A côté de ça, je suis en train de consulter la documentation de Texinfo, le système conçu à la base pour documenter les logiciels Gnu (mais qui peut servir aussi pour d'autres docs). Attention, on passe à un autre niveau de complexité (du bon vieux made in Richard Stallman avec un mélange de Latex).
    https://www.gnu.org/software/texinfo/
    Je fini mon billet avec un petit mot concernant les pages de man. J'ai toujours trouvé, ces pages de manuel linux un peu imbuvables pour un débutant et par hasard (?), j'ai trouvé dans le livre "Linux Kernel Programming" (je ne sais pas dans quoi je me lance, là !!) qu'il existait un système appelé appelé Tl;dr (Too long; Didn't read = trop long, je n'ai pas lu, comme les pages de man trop touffues). Ce système a donc été conçu pour donner la documentation pour les options courantes des logiciels en ligne de commande. Voir : https://tldr.sh/ . Le pdf résume de nombreuses commandes : https://tldr.sh/assets/tldr-book.pdf (penser à activer la table des matières à gauche dans le pdf).
    Pour installer le système tldr :

    #regarder si npm (gestionnaire de paquets de node js) est installé :
    >npm --version
    #si ce n'est pas le cas, l'installer en mode admin (debian, ubuntu) :
    >sudo apt install npm
    #vérifier que npm est maintenant installé
    >npm --version
    #récupérer le paquet tldr
    >npm install -g tldr
    #fixer les vulnérabilités si besoin
    >sudo npm audit fix
    >npm i --package-lock-only
    #tester si tldr est bien installé
    >tldr --version
    #utiliser tldr pour voir les infos sur la commande cp (copie de fichiers)...
    #vous aurez droit à une mise à jour de la base de donnée la première fois
    >tldr cp
    #pour avoir l'aide sur tldr :
    >tldr --help
    #pour mettre à jour la base de donnée
    >tldr --update
    

    Et Voilà ! (Autentica qualità). Bon We.

  • Bel exposé sur le sujet.

    Il existe plusieurs logiciels (générateur de site statique) tel que MkDocs pour créer une documentation en ligne à partir de fichiers en markdown. Cependant ils nécessitent tous un apprentissage plus ou moins long (commande build, serve, etc. structure de fichiers, langage markdown, etc.).

    Les wiki (non mentionnés) permettent aussi de mettre en place une documentation (collaborative) et sont accessibles à tous avec très peu de connaissance.

Sujets suggérés

  • Qui utilise Pluxml ? (ou avis)

    Logiciels et multimédia
    3
    0 Votes
    3 Messages
    112 Vues

    @jolaradio depuis ton annonce as tu recu beaucoup de candidatures ?

  • 0 Votes
    4 Messages
    79 Vues

    enfin le 3e point consulter les log consulter le web ... que signifie lenteur pour une vidéo ? saccades ? merci de préciser. bonne après-midi ...

  • 0 Votes
    1 Messages
    58 Vues
    Personne n'a répondu
  • Convertisseur vocal

    Logiciels et multimédia
    9
    0 Votes
    9 Messages
    245 Vues

    Bonjour, nous nous utilisons Voice-to-text qui 'ouvre avec Google Chrome. Il y a desraccourcis claver pour les personnes mal-voyantes ou aveugles.
    https://www.textfromtospeech.com/fr/voice-to-text/

  • Faire le ménage

    Logiciels et multimédia
    2
    0 Votes
    2 Messages
    144 Vues

    un article avait déjà été consacré à ce programme en complément de fslint.

    https://forum.linuxchallans.org/topic/377/vous-connaissiez-fslint-voilà-czkawka-son-successeur-écrit-en-rust

  • Ventoy

    Logiciels et multimédia
    5
    1 Votes
    5 Messages
    191 Vues

    Quelques idées de distributions pour débutant à copier sur sa clé Ventoy :

    Ubuntu (variantes Lubuntu, Xubuntu ou Kubuntu) possède la plus grande communauté d'utilisateurs avec un support à long terme (LTS). Mint (environnements de bureau Cinnamon, Mate ou Xfce) basée sur Ubuntu est une distribution prête à l'emploi. On trouve dans cette distribution Warpinator dont le but est de faciliter les échanges de fichiers sur le réseau local. Elementary OS (environnement de bureau Pantheon) basée sur Ubuntu avec un look proche de macOS. Manjaro basée sur Arch linux a pour caractéristiques une installation simplifiée, une détection automatique du matériel, de se mettre à jour au fil du temps (rolling-release). MX Linux basée sur Debian supporte encore 2 environnements de bureau (Xfce et Fluxbox) pour les architectures matérielles 32 bit. Garuda basée sur Arch Linux. Cette distribution a de nombreux atouts : mode de mise à jour de type rolling-release (mise à jour en continue), Zen kernel, système de fichier Btrfs par défaut, Timeshift, Optimisée pour le jeux, Firedragon pour navigateur web, Searx pour moteur de recherche, ...
  • Images disque Raspberry Pi

    Logiciels et multimédia
    6
    0 Votes
    6 Messages
    278 Vues

    @papinou Il y a 8 ans j'installais la version 4 d'OpenELEC pour un restaurant à Benodet (29) pour diffuser ses MP3. J'ai adoré cette distribution linux destinée au PC média center. Très légère en ressources matériels, une navigation moderne avec une interface personnalisable, de nombreux plugins, etc.

    Je viens de tester son successeur LibreELEC sur Raspberry Pi pour regarder la télévision au moyen de ma connexion internet. Les grandes étapes sont la gravure de LibreELEC sur carte SD, le démarrage du raspberry pi, l'installation des plugins Catch-up TV & More, IPTV Manager, IPTV Simple Client. Et voilà !

    Enfin il ne reste plus qu'à installer une appli sur son smartphone pour le transformer en télécommande !

  • Installation whatsapp sous linux

    Logiciels et multimédia
    15
    0 Votes
    15 Messages
    584 Vues

    bonjour @maithodile je te souhaite une bonne année. j'ai quitté linphone pour jami https://jami.net/ facile à utiliser et qui fonctionne très bien ! utilisable sur tous les environnements.