📚 Markdown Syntax Guide
A comprehensive reference guide and cheat-sheet detailing headings, tables, links, images, and formatting syntax.
Standard Formatting Cheat-Sheet
Below is a reference guide mapping standard Markdown shorthand symbols to their visual outcomes and compiled HTML elements.
| Element | Markdown Syntax | HTML Output |
|---|---|---|
| Header 1 | # Heading 1 | <h1>Heading 1</h1> |
| Header 2 | ## Heading 2 | <h2>Heading 2</h2> |
| Bold Text | **Heavy Text** | <strong>Heavy Text</strong> |
| Italic Text | *Slanted Text* | <em>Slanted Text</em> |
| Blockquote | > Quote content | <blockquote>Quote content</blockquote> |
| Unordered List | - List Item | <ul><li>List Item</li></ul> |
| Ordered List | 1. List Item | <ol><li>List Item</li></ol> |
| Inline Code | \`const x = 5;\` | <code>const x = 5;</code> |
| Link | [DevSuite](https://...) | <a href="...">DevSuite</a> |
Best Practices for Writing Markdown
1. **Preserve Spacing**: Always place an empty line before and after list items, tables, code blocks, and blockquotes to ensure different markdown parser engines group paragraphs correctly. 2. **Heading Spaces**: Make sure to insert a literal space between the `#` character symbols and the header text (e.g. use `# Header`, not `#Header`). 3. **Escape Special Characters**: If you want to render literal asterisks or hashes without formatting them, prefix them with a backslash character (e.g., `\\*`).