fixed the escaping

Author: Davda-James

dev/generate_cli_docs.py

@@ -32,6 +32,26 @@ def clean_usage_line(usage: str) -> str:
     return usage.replace("Usage: cli ", "Usage: cocoindex ")
 
 
+def escape_html_tags(text: str) -> str:
+    """Escape HTML-like tags in text to prevent MDX parsing issues, but preserve them in code blocks."""
+    import re
+
+    # Split text into code blocks and regular text
+    # Pattern matches: `code content` (inline code blocks)
+    parts = re.split(r"(`[^`]*`)", text)
+
+    result = []
+    for i, part in enumerate(parts):
+        if i % 2 == 0:
+            # Even indices are regular text, escape HTML tags
+            result.append(part.replace("<", "&lt;").replace(">", "&gt;"))
+        else:
+            # Odd indices are code blocks, preserve as-is
+            result.append(part)
+
+    return "".join(result)
+
+
 def format_options_section(help_text: str) -> str:
     """Extract and format the options section."""
     lines = help_text.split("\n")
@@ -66,6 +86,7 @@ def format_options_section(help_text: str) -> str:
             # Save previous option if exists
             if current_option is not None:
                 desc = " ".join(current_description).strip()
+                desc = escape_html_tags(desc)  # Escape HTML tags for MDX compatibility
                 formatted_options.append(f"| `{current_option}` | {desc} |")
 
             # Remove the leading 2 spaces
@@ -91,6 +112,7 @@ def format_options_section(help_text: str) -> str:
     # Add last option
     if current_option is not None:
         desc = " ".join(current_description).strip()
+        desc = escape_html_tags(desc)  # Escape HTML tags for MDX compatibility
         formatted_options.append(f"| `{current_option}` | {desc} |")
 
     if formatted_options:
@@ -157,7 +179,8 @@ def extract_description(help_text: str) -> str:
         elif in_description and line.strip():
             description_lines.append(line.strip())
 
-    return "\n\n".join(description_lines) if description_lines else ""
+    description = "\n\n".join(description_lines) if description_lines else ""
+    return escape_html_tags(description)  # Escape HTML tags for MDX compatibility
 
 
 def generate_command_docs(docs: List[Dict[str, Any]]) -> str:

docs/docs/core/cli-reference.md

@@ -152,7 +152,7 @@ Usage: cocoindex server [OPTIONS] APP_TARGET
 | `-a, --address TEXT` | The address to bind the server to, in the format of IP:PORT. If unspecified, the address specified in COCOINDEX_SERVER_ADDRESS will be used. |
 | `-c, --cors-origin TEXT` | The origins of the clients (e.g. CocoInsight UI) to allow CORS from. Multiple origins can be specified as a comma-separated list. e.g. `https://cocoindex.io,http://localhost:3000`. Origins specified in COCOINDEX_SERVER_CORS_ORIGINS will also be included. |
 | `-ci, --cors-cocoindex` | Allow https://cocoindex.io to access the server. |
-| `-cl, --cors-local INTEGER` | Allow http://localhost:<port> to access the server. |
+| `-cl, --cors-local INTEGER` | Allow http://localhost:&lt;port&gt; to access the server. |
 | `-L, --live-update` | Continuously watch changes from data sources and apply to the target index. |
 | `--setup` | Automatically setup backends for the flow if it's not setup yet. |
 | `--reexport` | Reexport to targets even if there's no change. |