• Cheatsheet for Writing New Posts

  • Embedding Images
  • Code Blocks
  • Creating Links
  • Organizing Information with Lists
  • Highlighting Content with Blockquotes
  • Presenting Data with Tables
  • Emphasizing Key Points
  • Adding Math Equations
  • Using Mermaid for Diagrams
  • Citations and References
  • Inline HTML
  • Embedding Videos
  • Conclusion
  • References

Cheatsheet for Writing New Posts

Welcome to this concise cheatsheet designed to summarize the essential markdown syntax for writing effective blog posts. This guide serves as a quick reference for both new and experienced bloggers.

Embedding Images

Embed images to enhance your content and engage readers visually:

![Serene Landscape](/images/posts/cheatsheet_md/test_img.webp) <!-- w=300 desc="Image generated by [Dall-E 3](https://openai.com/dall-e-3/)" -->

Code Blocks

Incorporate code snippets to clarify technical explanations or showcase examples:

def greet(name):
    print(f"Hello, {name}!")

function isEven(num) {
  return num % 2 === 0;
}

// Testing the function
const num = 4;
if (isEven(num)) {
  console.log(`${num} is even.`);
} else {
  throw new Error('Wait, what?');
}

Creating Links

Link to external sites or related pages to provide additional information:

[Visit our website](https://example.com)

Visit our website

Organizing Information with Lists

Clearly organize information using bulleted or numbered lists:

• Item 1
• Item 2

Highlighting Content with Blockquotes

Use blockquotes to highlight important quotes or content:

> "The only way to do great work is to love what you do." - Steve Jobs

“The only way to do great work is to love what you do.” - Steve Jobs

Presenting Data with Tables

Tables are useful for presenting data or comparative information neatly:

| Name  | Age | Location | Info  |
|-------|:---:|:------|------:|
| Alice | 25  | New York |  None |
| Bob   | 30  | London   | None |

Emphasizing Key Points

Emphasize key points using bold, italic, or underlined text:

**Bold Text**
*Italic Text*
***Bold and Italic Text***
~Strikethrough Text~  
<u>Underline Text</u>
<strike>Middle Line Text</strike>
<sup>Superscript Text</sup>

---

Bold Text
Italic Text
Bold and Italic Text
Strikethrough Text
Underline Text
Middle Line Text
^{Superscript Text}

Adding Math Equations

Enhance scientific or academic posts with inline or block math equations:

Both inline and block math equations are supported. Here is an example of an inline math equation: $E=mc^2$.

$$
PE(pos, 2i) = \sin(\frac{pos}{10000^{\frac{2i}{d_{\text{model}}}}})
$$

"```math
L = \frac{1}{2} \rho v^2 S C_L
```"

Both inline and block math equations are supported. Here is an example of an inline math equation: $E=mc^2$.

Using Mermaid for Diagrams

Mermaid is a diagramming and charting tool that enables you to create flowcharts, sequence diagrams, Gantt diagrams, and more. Here are some examples:

Note: Detached the support for Mermaid diagrams.

Citations and References

Example of citations and references:

Li et al. ¹ leveraged planar regularities for point line visual-inertial odometry.
In another work, Li et al. ² proposed a co-planar parametrization method for stereo-SLAM and visual-inertial odometry.
Liu et al. ³ developed a deep learning-based channel estimation method for double-RIS aided massive MIMO systems.
Xu et al. ⁴ introduced PVI-DSO, a direct sparse visual-inertial odometry method that leverages planar regularities.
Li et al. ¹, Li et al. ², and Xu et al. ⁴ are a series of works that leverage planar regularities for visual SLAM.

Inline HTML

You can also use inline HTML to customize your content:

<details>
  <summary>Click to expand</summary>
  This is a hidden content block that can be expanded.
</details>

Embedding Videos

Note: The following iframe examples are shown as plain text to avoid embedding videos in this guide. To embed a YouTube video, copy the iframe code and paste it into your markdown file.

<iframe width="420" height="315" src="https://www.youtube.com/watch?v=1H6gjsiza1A"></iframe>
<iframe width="420" height="315" src="https://www.youtube.com/embed/1H6gjsiza1A"></iframe>

Conclusion

This guide provides a foundation for using Markdown to create visually appealing and structurally sound blog posts. Happy blogging!

References