Skip to content

README.en.md

Latest commit

 

History

History
82 lines (56 loc) · 4.54 KB

README.en.md

File metadata and controls

82 lines (56 loc) · 4.54 KB

ChatMD

ChatMD is a free, open-source tool that enables you to create custom chatbots from simple Markdown files.

✨ Key Features

Simplicity

  • Build a chatbot in minutes with an easy-to-learn syntax
  • Use the tool directly online, no server installation needed

Customization and Flexibility

  • Fully configurable interface
  • Extended syntax (variables, conditions, etc.) to create more advanced chatbots

Optional AI Integration

  • AI is not enabled by default, but can be integrated in a targeted and efficient way
  • RAG (Retrieval-Augmented Generation) support for custom knowledge base integration

GDPR Compliance

  • No account required
  • No personal data collected

Optimized and Eco-Friendly Code

  • Lightweight, fast, and energy-efficient (A+ eco-rating)
  • Perfect scores (100%) across all Lighthouse metrics
  • 100% success on automated accessibility checks (awaiting a full audit)

⚙️ How It Works

  1. Create a publicly accessible Markdown file
  2. Format it using ChatMD's syntax to define your chatbot behavior
  3. Access your chatbot instantly at: https://chatmd.forge.apps.education.fr/#URL (Replace URL with your file's URL)

While the basic syntax is straightforward, ChatMD offers advanced configuration options for sophisticated use cases: interface customization, variable implementation, randomized responses, Large Language Model integration, and Retrieval-Augmented Generation capabilities.

For comprehensive guidance, explore our starter chatbot.

🎯 Potential Applications

ChatMD offers versatile applications across a wide range of educational and institutional contexts:

  • Answering frequently asked questions (FAQs)
  • Step-by-step tutorials for software tools
  • Decision-making or creative support
  • Methodological guidance
  • Knowledge review and interactive quizzes
  • Training tool, methodological assistance, or topic exploration
  • Conversation with a historical figure
  • Choose-your-own-adventure story
  • Escape games, investigations, and more...

ChatMD can even integrate geolocation, enabling additional features such as:

  • Interactive treasure hunts
  • Enhanced educational field trips
  • Location-based recommendations

🙋‍♀️ Contributing

Interested in contributing to or discussing this project? Please review our CONTRIBUTING.md file for guidelines and information.

👩‍⚖️ License

ChatMD is distributed under the MIT license as free and open-source software. The complete source code is available on la Forge des Communs Numériques Éducatifs, a development platform for digital commons, supported by the French Ministry of National Education.

🙏 Acknowledgments

ChatMD was developed with institutional support from DRANE Lyon and the DNE as part of their initiative to promote digital commons and open-source educational software.

ChatMD also benefited from the support of the Incubator of the French Ministry of National Education, and in particular from the assistance of Thomas Sanson. Many thanks for the valuable guidance, which helped structure the development of this application in a more professional way!

Special thanks to Perrine Douhéret, Laetitia Allegrini, Romain Estampes, Charlie Rollo, Mélanie Fenaert, Jean-Marc Viglino for their valuable improvement suggestions, and to all beta testers who provided essential feedback!

ChatMD builds upon several excellent open-source projects:

If you find this project useful, you might be interested in exploring other tools and resources available on my personal website.