Skip to content

Variables

Using Variables in MarkdownFlow

Variables are the foundation of dynamic content in MarkdownFlow. They act as placeholders that get replaced with actual values during processing, enabling personalized and context-aware documents.

Basic Syntax

Variables use double curly braces:

{{variable_name}}

Simple example:

Say hello to {{user_name}}! Tell the user the account balance is {{balance}}.

Variable Naming Rules

Variable names are case-sensitive and must follow these rules:

  • Can contain: Letters (including Unicode letters like Chinese, Japanese, etc.), numbers, and underscores
  • Cannot contain: Special characters, spaces, punctuation marks, or the } character
  • Cannot be: Empty (must have at least one character)
  • No spaces between braces and name: {{ var }} is NOT recognized as a variable

Valid Variable Names

{{name}} ✓ Simple letters
{{userName}} ✓ camelCase
{{user_name}} ✓ snake_case
{{UserName}} ✓ PascalCase
{{user123}} ✓ With numbers
{{_private}} ✓ Starting with underscore
{{CONSTANT}} ✓ All caps
{{a}} ✓ Single character
{{123user}} ✓ Starts with number
{{用户名}} ✓ Unicode characters (Chinese)
{{ユーザー}} ✓ Unicode characters (Japanese)
{{пользователь}} ✓ Unicode characters (Russian)
{{utilisateur}} ✓ Unicode characters (French)

Invalid Variable Names

{{user}name}} ✗ Contains } character
{{user name}} ✗ Contains space inside name
{{user-name}} ✗ Contains hyphen
{{user.name}} ✗ Contains dot
{{user@email}} ✗ Contains special characters
{{🚀rocket}} ✗ Contains emoji
{{name[0]}} ✗ Contains brackets
{{user+id}} ✗ Contains plus sign
{{}} ✗ Empty variable
{{   }} ✗ Only spaces
{{ name }} ✗ Spaces between braces and name (not recognized as variable)
{{ name}} ✗ Space before name (not recognized as variable)
{{name }} ✗ Space after name (not recognized as variable)

How Variables Work

1. Declaration and Assignment

Variables get their values from multiple sources:

User Input:

Ask the user for their name politely.
?[%{{name}} ...Enter your name]

Generate a warm, personalized greeting for {{name}}.

System Predefined Variables:

System variables are pre-assigned by the platform and can be used directly without any user input. Different platforms provide different system variables:

MarkdownFlow Playground:

  • {{browser_language}} - User's browser language (e.g., "en-US", "zh-CN")

AI-Shifu Platform:

  • {{sys_user_nickname}} - User's display name
  • {{sys_user_style}} - User's preferred content style
  • {{sys_user_background}} - User's background information
  • {{sys_user_language}} - User's language preference

2. Variable Replacement

Before the LLM processes the content, the MarkdownFlow Agent replaces all variables with their values:

Before: "Generate a personalized greeting for {{user_name}} who is learning {{topic}} at {{level}} level."
After: "Generate a personalized greeting for Alice who is learning Python at beginner level."

The LLM then processes this resolved prompt to generate the actual content for the reader.

3. Unassigned Variables

If a variable has not been assigned a value, it's replaced with "UNKNOWN":

Before: "Create content for {{user_type}} interested in {{topic}}."
After: "Create content for UNKNOWN interested in UNKNOWN."

Important: Always assign values to variables before using them, typically through user input or system defaults, to avoid "UNKNOWN" appearing in your prompts. When the LLM receives "UNKNOWN" in prompts, its output may be random and unpredictable, failing to meet your expectations.

Variables in Different Contexts

Variables work everywhere in your document:

In Text

Create a personalized welcome message for {{username}} that feels warm and familiar.

In Headers

# Chapter {{chapter_number}}: {{chapter_title}}

In Lists

Summarize the user's product selections in a clear list format:
- Their chosen color: {{selected_color}}
- Their selected size: {{selected_size}}  
- The quantity they want: {{quantity}}

[Visit {{site_name}}]({{site_url}})
![{{image_description}}]({{image_path}})

In Tables

Create a formatted table showing the user's account information:
| Property | Value                 |
| -------- | --------------------- |
| Name     | {{user_name}}         |
| Email    | {{user_email}}        |
| Plan     | {{subscription_plan}} |

In HTML

<div class="{{theme_class}}">
  <span id="user-{{user_id}}">{{display_name}}</span>
</div>