Skip to content

miyan1221/chat-markdown

 
 

Repository files navigation

Chat-Markdown

Chat-Markdown is an open-source project that allows you to chat with your markdown files.

Demo

Demo Site

Deploy on Vercel and Railway

Features

  • 🤖 Chat with your markdown files
  • 📝 Summarize articles
  • 🖍️ Highlight source
  • 📤 Upload files
  • 💾 Data saved locally
  • 💰 Token usage tracker

Future Development

I plan to add the following features in the future:

  • Support for more file formats: pdf, txt
  • Download doc from the internet
  • Markdown-formatted message
  • i18n
  • Desktop application

If you find this project helpful, please consider giving it a star 🌟

How to run locally?

Create .env

Create .env file and fill in environment variables, see .env.example for reference

Frontend

Install dependencies

yarn
yarn dev

Backend

you need a python environment

Create virtual environment

cd api-src
python -m venv .venv

Active virtual environment

windows

.venv\Scripts\activate

mac

. .venv/bin/activate

Install dependencies

pip install -r requirements.txt

Run Services

flask run --reload

About

chat with your markdown files

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • HTML 78.0%
  • TypeScript 12.0%
  • Python 8.9%
  • Other 1.1%