Skip to content

MarkdownFlow extends standard Markdown with AI to create personalized, interactive documents. Tagline: "Write Once, Deliver Personally"

License

Notifications You must be signed in to change notification settings

ai-shifu/markdown-flow

Repository files navigation

MarkdownFlow Logo MarkdownFlow

Write Once, Deliver Personally

MarkdownFlow extends standard Markdown with AI to create personalized, interactive pages. Instead of writing static content for readers, you write prompts for AI agents that transform your instructions into personalized content adapting to each user's choices, preferences, and context.

✨ What Makes MarkdownFlow Special

  • 📝 Fully Compatible with Markdown - All standard Markdown syntax works unchanged
  • 🤖 AI-Powered Personalization - Write prompts for AI, not content for humans
  • 🎯 Three Simple Extensions - Variables, interactive elements, and preserved content
  • 🌍 Multi-Language Support - Built with international audiences in mind

🚀 Quick Links

Resource Description Link
🌐 Official Website Project homepage and overview markdownflow.ai
🎮 Playground Try MarkdownFlow interactively play.mdflow.run
📚 Documentation Complete guides and references markdownflow.ai/docs

🔧 Open Source Projects

Frontend Libraries

Project Description Language License
markdown-flow-ui Complete UI components with built-in functionality. Ready-to-use React components for interactive markdown documents. React/TypeScript MIT
remark-flow React-markdown plugin for MarkdownFlow syntax. Extends react-markdown with variable processing and AI integration. TypeScript MIT
markdown-it-flow Markdown-it plugin for MarkdownFlow syntax. Adds MarkdownFlow capabilities to any markdown-it powered application. TypeScript MIT

Backend Implementations

Project Description Language License
markdown-flow-agent-py A Python library to transform MarkdownFlow documents into personalized content. Python MIT
markdown-flow-agent-go A Go library to transform MarkdownFlow documents into personalized content. (Coming soon) Go MIT

Core Documentation

Project Description License
markdown-flow Main documentation, website, and development platform. Interactive demo showcasing MarkdownFlow capabilities. CC

📖 Quick Start

MarkdownFlow adds three simple extensions to standard Markdown:

1. Variables: {{variable}}

Dynamic content placeholders that get replaced with actual values.

Generate a welcoming message for {{user_name}} that mentions their
current account balance of {{balance}} in a friendly tone.

2. Interactive Elements: ?[%{{variable}} Option1 | Option2]

Buttons and input fields that collect user choices.

Ask the user about their experience level:
?[%{{level}} Beginner | Intermediate | Expert]

Collect the user's name:
?[%{{name}}...Enter your name here]

3. Preserved Content: ===content===

Text that maintains its exact meaning during AI processing.

Introduce our company values, preserving the exact motto:
===Innovation Through Simplicity===

🌟 Use Cases

  • 📚 Education - Personalized learning materials adapting to student levels
  • ✍️ Content Creation - Articles adjusting terminology based on reader expertise
  • 📰 News Media - Stories expanding from different angles based on interests
  • 🎮 Interactive Storytelling - Narratives where choices influence plot direction

🎯 Getting Started

  1. 📖 Read Core Concepts - Understand fundamental principles
  2. ⚡ 5-Minute Quick Start - Build your first interactive document
  3. 🎮 Try the Playground - Practice with live examples
  4. 🚀 Integration Guide - Add to your project

📄 License

This project is licensed under Creative Commons. Individual components have their own licenses (MIT for most libraries).

🏢 About

Created by AI Shifu, LLC • © 2025


Core Principle: Write prompts for AI, not content for humans

About

MarkdownFlow extends standard Markdown with AI to create personalized, interactive documents. Tagline: "Write Once, Deliver Personally"

Topics

Resources

License

Stars

Watchers

Forks

Contributors 5