Skip to content

SDK Documentation

MarkdownFlow provides SDKs for major programming languages and frameworks. Choose the SDK that fits your technology stack.

Quick Comparison

SDK Language Use Case Package
markdown-flow-ui React Full UI components npm install markdown-flow-ui
remark-flow React Markdown plugin npm install remark-flow
markdown-it-flow JavaScript Parser plugin npm install markdown-it-flow
Python Agent Python Backend processing pip install markdown-flow-agent
Go Agent Go High-performance backend go get github.com/ai-shifu/markdown-flow-agent-go

Frontend SDKs

React

Vue.js

Vanilla JavaScript

Backend SDKs

Python

Go

Choosing an SDK

For Web Applications

Need a complete solution? → Use markdown-flow-ui (React)

Already using react-markdown? → Add remark-flow plugin

Using Vue or vanilla JS? → Use markdown-it-flow

For Backend Services

Need rapid development? → Python Agent with FastAPI

Need maximum performance? → Go Agent

Existing microservices? → Either, both support REST APIs

Common Integration Patterns

Full-Stack React + Python

React App (markdown-flow-ui)
    ↓ HTTP/WebSocket
Python Backend (markdown-flow-agent)
    ↓ API calls
LLM Provider (OpenAI/Anthropic)

Vue + Go High-Performance

Vue App (markdown-it-flow)
    ↓ HTTP/WebSocket
Go Backend (markdown-flow-agent-go)
    ↓ API calls
LLM Provider

Microservices Architecture

Frontend (Any SDK)
    ↓
API Gateway
    ↓
Multiple Backends (Python/Go)
    ↓
LLM Service

Quick Start Examples

React

import { MarkdownFlow } from "markdown-flow-ui";

<MarkdownFlow template={template} />;

Python

from markdown_flow_agent import FlowAgent

agent = FlowAgent()
result = await agent.process(template, variables)

Go

agent := mf.NewAgent(config)
result, err := agent.Process(template, variables)

Feature Matrix

Feature UI remark markdown-it Python Go
Variables ✅ ✅ ✅ ✅ ✅
User Input ✅ ✅ ✅ ✅ ✅
AI Processing ✅ ⚠️ ⚠️ ✅ ✅
Styling ✅ ❌ ❌ N/A N/A
TypeScript ✅ ✅ ✅ N/A N/A
Streaming ✅ ❌ ❌ ✅ ✅
Caching ✅ ❌ ❌ ✅ ✅

Legend: ✅ Full support | ⚠️ Requires backend | ❌ Not supported | N/A Not applicable

Getting Help