Git Product home page Git Product logo

chatmd's Introduction

ChatMD

ChatMD est un chatbot, que vous pouvez configurer par vous-même en Markdown :

  • Créez un fichier en markdown et mettez-le en ligne : sur CodiMD, ou sur une forge
  • Respectez la syntaxe de ChatMD pour définir votre chatbot

Votre chatbot est alors prêt et visible à l'adresse suivante : https://eyssette.forge.aeif.fr/chatMD/#URL (Mettez l'url de votre fichier à la place de URL)

Exemples

Voici un modèle que vous pouvez récupérer pour construire votre chatbot : modèle à récupérer

Voici quelques exemple de chatbot créés avec ChatMD :

Syntaxe

La syntaxe pour écrire un chatbot avec chatMD est la suivante :

  • On définit le titre du chatbot dans un titre de niveau 1
  • Le message initial est à mettre dans un bloc de citation après le titre du chatbot
  • Les titres de niveau 2 servent à identifier les réponses possibles du chatbot
  • Sous chaque titre de niveau 2 :
    • On indique avec une liste non ordonnée les mots clés ou expressions qui vont déclencher la réponse. On peut éventuellement s'en passer si on guide l'utilisateur avec un choix d'options (voir ci-dessous).
    • On écrit une réponse en Markdown.
    • [Optionnel] On indique avec une liste ordonnée les options possibles. Chaque élément de la liste doit être un lien en Mardown de la forme suivante : `[intitulé de l'option](identifiant de l'option, qui doit correspondre à l'un des titres de niveau 2)`.

Options de configuration plus avancées

On peut ajouter un en-tête yaml à son fichier Markdown.
Par exemple :

clavier: false
rechercheContenu: true
gestionsGrosMots: true
style: a{color:red}
maths: true
titresRéponses: ["### ", "#### "]
  • clavier: false désactive le champ d'entrée clavier si on souhaite simplement guider l'utilisateur avec les options proposées en fin de chaque réponse.
  • rechercheContenu: true permet d'ajouter une recherche de comparaison de l'entrée de l'utilisateur avec le contenu de chaque réponse
  • gestionGrosMots: true permet de détecter les gros mots envoyés par l'utilisateur et de formuler une réponse adéquate si l'utilisateur en utilise
  • style: a{color:red} permet d'ajouter des styles CSS personnalisés.
  • maths: true permet d'écrire des formules mathématiques en Latex avec la syntaxe $Latex$ ou $$Latex$$
  • titresRéponses: "### " permet de changer l'identifiant des réponses du chatbot si on veut pouvoir structurer les réponses du chatbot dans son document
  • titresRéponses: ["### ", "#### "] permet de changer les identifiants possibles des réponses du chatbot si on veut pouvoir structurer les réponses du chatbot dans son document

Crédits

Chat MD est un outil libre et gratuit sous licence MIT.

Il utilise d'autres logiciels libres :

chatmd's People

Contributors

eyssette avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.