Next Steps

Congratulations! You've learned the fundamentals of MarkdownFlow. Here's your roadmap for becoming an MDFlow expert.

🎯 Choose Your Path

Path 1: Deep Dive into Specification

Master every detail of MDFlow syntax and capabilities.

Recommended Reading Order:

Specification Overview
Understand MDFlow's position as a Markdown extension
How It Works
Learn the technical processing workflow
Interaction Explore buttons, options, and input with natural references to recent answers
Preserved Output Control content preservation and translation
Memory Learn how to save questions and answers for later use within the platform's memory scope

Path 2: Learn from Examples

See MDFlow in action across different domains.

Explore the Playground:

Try interactive examples at play.mdflow.run
Experiment with different use cases
See real-time rendering
Copy and modify templates

Path 3: Start Building

Jump straight into development with your preferred technology.

Choose Your SDK:

Frontend Frameworks

markdown-flow-ui - React/Next.js component
remark-flow - React Markdown processor
markdown-it-flow - Vue/Vanilla JS parser

Backend Solutions

Python SDK - FastAPI/Django integration
Go SDK - High-performance processing

Integration details: Integration Guide

📚 Best Practices

Writing Effective MDFlow Documents

1. Start Simple, Iterate

# Version 1: Basic
Generate a friendly welcome.

# Version 2: Add interaction
Ask the user for their name.
?[...Enter name]
Generate a greeting using the name the user entered.

# Version 3: Add personalization
Ask the user for their name.
?[...Enter name]

Ask the user what brings them here.
?[Learning|Building|Exploring]

Generate a warm welcome using the user's name and selected goal.

2. Be Specific with AI Instructions

# Too vague ❌
Tell the user about the selected topic.

# Clear and specific ✅
Explain the topic to the user's chosen experience level in exactly 3 paragraphs:
1. Core concept (50 words)
2. Practical example from the user's selected industry (75 words)
3. Action they can take today (50 words)

3. Plan User Journeys

Map out different paths users might take:

New user → Onboarding → Basic features
Returning user → Skip intro → Advanced options
Expert user → Direct access → Power features

4. Test Edge Cases

Always consider:

Empty inputs
Very long inputs
Special characters
Different languages
Unexpected combinations

Common Patterns

Progressive Disclosure

Show basic info about the selected topic.

Ask whether the user wants more details.
?[Yes, tell me more|No, that's enough]

If the user chose "Yes": provide in-depth explanation
If the user chose "No": summarize and conclude

Contextual Adaptation

Explain the selected concept using analogies from the reader's background:
- If tech: use programming examples
- If business: use market scenarios
- If creative: use artistic metaphors

Feedback Loops

Ask the user how helpful the explanation was.
?[Very helpful|Somewhat helpful|Not helpful]

If "Not helpful": ask what they need clarification on
If "Somewhat helpful": offer additional resources
If "Very helpful": suggest next topics

🛠 Development Tips

1. Version Control

Track your MDFlow templates in Git:

# Good practice: separate templates
templates/
  onboarding.md
  tutorial.md
  feedback.md

2. Template Organization

# Template Header
<!--
  Template: User Onboarding
  Version: 1.2.0
  Inputs: name, role, experience
  Memory questions: none
  Last Updated: 2024-03-15
-->

# Content starts here...

3. Context Documentation

Keep track of the interaction answers and saved memory your template expects:

<!-- Context Used:
  Interaction: user's display name
  Interaction: selected role (student/teacher/admin)
  Memory question: {{What would you like to learn?}} - Previously saved learning goal
-->

4. Testing Strategy

Create test cases for your templates:

const testCases = [
  { name: "Alice", role: "student", level: "beginner" },
  { name: "Bob", role: "teacher", level: "expert" },
  { name: "Zoë O'Connor 🚀", role: "admin", level: "intermediate" }
];

🤝 Get Help & Connect

Community Resources

GitHub Repository - github.com/ai-shifu/markdown-flow
Discord Community - Join discussions and get help
Stack Overflow - Tag: markdown-flow

Stay Updated

Follow our blog for tutorials and updates
Subscribe to the newsletter for new features
Check the changelog for latest releases

Contributing

MDFlow is open source! Ways to contribute:

Report bugs - Help us improve stability
Suggest features - Share your use cases
Submit examples - Show what you've built
Improve docs - Help others learn
Create SDKs - Support new platforms

🚀 Advanced Topics

Ready for more? Explore these advanced concepts:

Custom Processors

Learn to extend MDFlow with custom processing logic:

Pre-processing hooks
Custom memory providers
Post-processing transformations

Integration Patterns

CMS integration
API-driven content
Database-backed memory
Multi-language support

Performance Optimization

Template caching strategies
Lazy loading techniques
Bundle size optimization
Server-side rendering

Analytics & Insights

Track how users interact with your MDFlow content:

Choice analytics
Path analysis
Completion rates
A/B testing

📋 Quick Reference

Essential Links

Playground - Try MDFlow online
Specification - Complete syntax reference
SDKs - Development libraries

Cheat Sheet

# Buttons
?[Option1|Option2]                        # Simple buttons
?[Button Text//value]                     # Different display/value

# Input
?[...Enter text]                          # Text input

# Options
?[Option1||Option2]                       # Multiple selection

# Preserved Content
===Exact text===                          # Preserve formatting/meaning

# Combined
?[Yes|No|...Other]                       # Buttons + input

# Memory
{{What would you like to learn?}}          # Refer to a saved answer
?[{{Which topic interests you?}} AI|Writing] # Save an answer under its question

🎓 Final Tips

Start small - Build simple templates first
Test often - Try different user paths
Get feedback - Share with real users
Iterate - Improve based on usage
Share - Help the community grow

Remember: The goal is to create content that adapts to each reader, making their experience personal and engaging.

Ready to Build?

You now have everything you need to create amazing MDFlow experiences:

✅ Understanding of core concepts
✅ Hands-on practice with examples
✅ Access to tools and resources
✅ Clear path for continued learning

Start creating your first real project today!

Return to Getting Started | Jump to Playground