diff --git a/MarkdownGuide.md b/MarkdownGuide.md new file mode 100644 index 0000000..c0b391a --- /dev/null +++ b/MarkdownGuide.md @@ -0,0 +1,121 @@ +# React Markdown — Features Reference + +This document describes what markdown syntax is supported when writing the `extended_description` field. The field is rendered using [`react-markdown`](https://remarkjs.github.io/react-markdown/), which follows the [CommonMark](https://commonmark.org/) spec by default. + +--- + +## Available Features + +| Feature | Syntax | Example | +|---|---|---| +| **Headings** | `# H1` through `###### H6` | `## Section Title` | +| **Bold** | `**text**` or `__text__` | `**important**` | +| **Italic** | `*text*` or `_text_` | `*emphasis*` | +| **Bold + Italic** | `***text***` | `***critical***` | +| **Inline code** | `` `code` `` | `` `null` `` | +| **Code blocks** | ` ```lang ``` ` | ` ```json ``` ` | +| **Blockquotes** | `> text` | `> Note: ...` | +| **Unordered lists** | `- item` or `* item` | `- Feature one` | +| **Ordered lists** | `1. item` | `1. Step one` | +| **Nested lists** | Indent with 2–4 spaces | ` - sub-item` | +| **Horizontal rule** | `---` or `***` | `---` | +| **Links** | `[label](url)` | `[docs](https://example.com)` | +| **Paragraphs** | Blank line between text | — | +| **Line breaks** | Two trailing spaces or `\n` | — | +| **Escaped characters** | `\*`, `\_`, `\`` etc. | `\*not bold\*` | +| **Strikethrough** | `~~text~~` *(via remark-gfm)* | `~~deprecated~~` | +| **Tables** | GFM pipe syntax *(via remark-gfm)* | see below | +| **Task lists** | `- [x] done` *(via remark-gfm)* | `- [ ] pending` | + +### Table syntax example + +```markdown +| Column A | Column B | +|----------|----------| +| value | value | +``` + +--- + +## Not Available (unsupported or unsafe) + +| Feature | Reason | +|---|---| +| Raw `` tags | Disabled by default — `react-markdown` strips HTML for security | +| `