Skip to content

devbyray/docs-for-ai

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

MarkItDown

Convert any file to Markdown — with a web UI, a REST API, and an MCP server for AI assistants.

Built on top of Microsoft's markitdown library.


What's inside

Package Description
api/ FastAPI service — accepts file uploads, returns Markdown
frontend/ Nuxt 3 web UI — drag-and-drop converter with live output
mcp/ MCP server — exposes conversion tools to AI assistants (Claude Desktop, VS Code, etc.)

Supported formats

PDF · Word (DOCX) · PowerPoint (PPTX) · Excel (XLSX / XLS) · Images (JPEG, PNG, …) · Audio (WAV, MP3) · HTML · CSV · JSON · XML · EPUB · ZIP · YouTube URLs · and more


Quick start

Prerequisites

Run everything

git clone https://github.com/YOUR_USERNAME/docs-for-ai.git
cd docs-for-ai

# API + Frontend
docker compose --profile frontend up --build -d
Service URL
Web UI http://localhost:4000
REST API http://localhost:8000
Swagger UI http://localhost:8000/docs (or http://localhost:4000/docs when frontend is running)

API only (no frontend)

docker compose up --build -d

The API is available at http://localhost:8000. Interactive docs at http://localhost:8000/docs.

All services including MCP

docker compose --profile frontend --profile mcp up --build -d

Docker Compose profiles

Profile flag Services started
(none) api only
--profile frontend api + frontend
--profile mcp adds mcp (run on-demand via stdin/stdout)
# Stop everything
docker compose --profile frontend --profile mcp down

Project structure

docs-for-ai/
├── docker-compose.yml
├── api/                  # FastAPI backend
│   ├── Dockerfile
│   ├── main.py
│   └── requirements.txt
├── frontend/             # Nuxt 3 frontend
│   ├── Dockerfile
│   ├── nuxt.config.ts
│   └── app/
│       └── app.vue
└── mcp/                  # MCP server
    ├── Dockerfile
    ├── server.py
    ├── requirements.txt
    └── claude_desktop_config.example.json

Development

Each package can be run independently. See the README in each subfolder for local dev instructions.


License

MIT

About

Convert any file to Markdown — REST API, Nuxt 3 web UI, and MCP server. Powered by Microsoft markitdown.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors