SDK Documentation
MarkdownFlow provides SDKs for major programming languages and frameworks. Each SDK is maintained as a separate open source project with its own comprehensive documentation.
Available SDKs
| SDK | Language | Use Case | Repository | Installation |
|---|---|---|---|---|
| markdown-flow-ui | React/TypeScript | Complete UI components | GitHub → | npm install markdown-flow-ui |
| remark-flow | TypeScript | React-markdown plugin | GitHub → | npm install remark-flow |
| markdown-it-flow | TypeScript | Parser plugin | GitHub → | npm install markdown-it-flow |
| markdown-flow-agent-py | Python | Backend processing | GitHub → | pip install markdown-flow-agent |
| markdown-flow-agent-go | Go | High-performance backend | GitHub → | go get github.com/ai-shifu/... |
Frontend SDKs
React
- markdown-flow-ui - Ready-to-use React components for interactive MarkdownFlow documents
- remark-flow - Plugin for react-markdown with variable processing and AI integration
Vue.js & Vanilla JavaScript
- markdown-it-flow - Parser plugin for any markdown-it powered application
Backend SDKs
Python
- markdown-flow-agent-py - Python library for transforming MarkdownFlow documents into personalized content
Go
- markdown-flow-agent-go - High-performance Go library for MarkdownFlow processing
Getting Started
- Choose your SDK based on your technology stack
- Visit the GitHub repository for detailed documentation
- Follow the installation and setup guides in each project's README
- Explore examples and tutorials in each repository
Each SDK repository contains:
- Complete installation instructions
- Usage examples and tutorials
- API documentation
- Configuration options
- Troubleshooting guides
Next Steps
- 🎮 Try the Playground - Experiment with MarkdownFlow syntax
- 📖 Integration Guide - Learn integration approaches
- 🚀 Quick Start - Build your first document