https://github.com/eyssette/chatMD
Un chatbot que l'on peut configurer avec un fichier en Markdown
https://github.com/eyssette/chatMD
chat chatbot markdown
Last synced: 10 months ago
JSON representation
Un chatbot que l'on peut configurer avec un fichier en Markdown
- Host: GitHub
- URL: https://github.com/eyssette/chatMD
- Owner: eyssette
- License: mit
- Created: 2023-10-13T08:28:40.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-12-08T22:32:36.000Z (over 1 year ago)
- Last Synced: 2024-12-15T18:14:40.602Z (over 1 year ago)
- Topics: chat, chatbot, markdown
- Language: JavaScript
- Homepage: https://eyssette.github.io/chatMD
- Size: 4.9 MB
- Stars: 4
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ChatMD
Translations :
[](https://github.com/eyssette/chatMD/blob/main/README.en.md)
[ChatMD](https://chatmd.forge.apps.education.fr/) est un outil libre et gratuit qui permet de créer facilement un chatbot personnalisé à partir d'un simple fichier en Markdown.
## ✨ Fonctionnalités clés
**Simplicité**
- Créez un chatbot en quelques minutes grâce à une syntaxe facile à apprendre
- Utilisation directe en ligne — aucune installation serveur nécessaire
**Personnalisation et flexibilité**
- Interface entièrement configurable
- Syntaxe étendue (variables, conditions, etc.) pour concevoir des chatbots plus avancés
**Intégration possible de l'IA**
- Pas d'IA par défaut, mais possibilité de l'intégrer de manière sobre et ciblée
- Prise en charge du RAG (Retrieval-Augmented Generation) pour que les réponses de l'IA intègrent une base de connaissances personnalisée.
**Compatibilité RGPD**
- Pas de compte à créer
- Aucune collecte de données personnelles
**Code optimisé et écoresponsable**
- Code très léger, rapide et à faible empreinte carbone (note A+)
- 100 % sur tous les indicateurs Lighthouse
- 100 % de réussite aux tests automatisés d’accessibilité (en attente pour un audit complet)
## ⚙️ Comment ça marche ?
1. Créez un fichier en Markdown accessible en ligne.
2. Respectez la syntaxe de ChatMD pour définir votre chatbot.
3. Votre chatbot est alors accessible à l'adresse suivante : `https://chatmd.forge.apps.education.fr/#URL` (Mettez l'url de votre fichier à la place de URL) !
Pour plus d'explications, laissez-vous guider par le [chatbot initial](https://chatmd.forge.apps.education.fr/).
## 🎯 Quels sont les usages possibles ?
On peut imaginer de nombreux usages :
- Réponse à des questions fréquentes (FAQ)
- Tutoriel pour un outil informatique
- Aide à la décision ou à la création
- Guide méthodologique
- Révision de connaissances, quiz interactif
- Outil de formation, d'aide méthodologique ou de découverte d'un sujet
- Discussion avec un personnage historique
- Histoire dont vous êtes le héros
- Escape game, enquête …
ChatMD peut même intégrer de la géolocalisation, ce qui permet d'autres usages :
- Jeu de piste
- Visite scolaire augmentée
- Recommandations fondées sur la position de l'utilisateur
## 🙋♀️ Contribuer
Si vous souhaitez contribuer ou tout simplement discuter de ce projet pour participer à l'améliorer, merci de lire le fichier [CONTRIBUTING.md](https://forge.apps.education.fr/chatMD/chatMD.forge.apps.education.fr/-/blob/main/CONTRIBUTING.md?ref_type=heads).
## 👩⚖️ Licence
[ChatMD](https://chatmd.forge.apps.education.fr/) est un outil libre et gratuit distribué sous licence MIT. Les sources sont disponibles sur [la Forge des Communs Numériques Éducatifs](https://forge.apps.education.fr/chatMD/chatMD.forge.apps.education.fr).
## 🙏 Crédits
[ChatMD](https://chatmd.forge.apps.education.fr/) n'aurait pas pu exister sans le soutien institutionnel de la DRANE Lyon et de la DNE, dans le cadre de leur politique de développement des communs numériques et du libre.
[ChatMD](https://chatmd.forge.apps.education.fr/) a également pu bénéficier du soutien de l'[Incubateur de l'Éducation Nationale](https://incubateur.education.gouv.fr/) et plus particulièrement de l'aide de Thomas Sanson. Merci beaucoup pour l'accompagnement proposé qui a permis de structurer le développement de cette application de manière plus professionnelle !
Merci également à Perrine Douhéret, Laetitia Allegrini, Romain Estampes, Charlie Rollo, Mélanie Fenaert, Jean-Marc Viglino pour leurs suggestions d'amélioration de l'outil, et merci à toutes les personnes qui ont pu tester ChatMD et me faire des retours !
[ChatMD](https://chatmd.forge.apps.education.fr/) est un logiciel libre qui repose également sur d'autres logiciels libres :
- [js-yaml](https://github.com/nodeca/js-yaml) pour la gestion des en-têtes yaml
- [typed.js](https://github.com/mattboldt/typed.js) pour l'effet "machine à écrire"
- [showdown](https://github.com/showdownjs/showdown) pour la conversion du markdown en html
- [leo-profanity](https://github.com/jojoee/leo-profanity) et [french-badwords-list](https://github.com/darwiin/french-badwords-list/) pour la gestion des gros mots
- [katex](https://katex.org/) pour la gestion des mathématiques en Latex
- [textFit](https://github.com/STRML/textFit) pour la gestion du redimensionnement automatique (ici : des formules mathématiques en Latex).
Si vous aimez ce travail, vous aimerez peut-être aussi les autres outils ou sites que je propose sur [mon site perso](https://eyssette.forge.apps.education.fr).