🔧 Troubleshoot Markdown Errors

A reference guide explaining common Markdown compilation warnings, rendering errors, and syntax resolution strategies.

← Dashboard

Common Markdown Formatting Issues

Unlike highly strict compilers (like JSON or XML), Markdown parsers usually do not crash or throw hard syntax errors when they encounter malformed tags. Instead, they fail silently, rendering corrupt visual outputs.

1. Nested List Spacing Failure

**Issue**: Sub-items are rendered on the same line as the parent item instead of nested underneath.
**Cause**: In Markdown, nested lists require a precise indentation prefix (either 2 or 4 spaces). Standard paragraph spacing must also be maintained.
**Fix**: Ensure your nested lists are indented with spaces:

- Parent Item
  - Nested Child Item (Indented with 2 spaces)

2. Unclosed Bold or Italic Symbols

**Issue**: Entire paragraphs of text below a formatted phrase are rendered in bold or italic weights.
**Cause**: Missing the closing syntax symbols (`**` or `*`) causes parsers to treat all succeeding text in the document as part of the style block.
**Fix**: Ensure every opening sequence has a matching closing symbol:

This **is bold** and this is regular text.

3. Raw HTML Script Vulnerabilities (XSS)

**Issue**: Malicious script inputs paste code like `<script>alert(1)</script>` that triggers in the preview.
**Cause**: Using a markdown compiler without escaping character entities (converting `<` and `>`) renders raw HTML components directly.
**Fix**: Use DevSuite's Markdown tool which automatically sanitizes and escapes all raw tags before generating DOM preview blocks.