Skip to content

Markdown CheatSheet @ Coding:

Building a Docs Website that requries .md files? Well here is a cheat sheet:

Bold:

To make your text BOLD simply add 2 astrixs before and after.

**BOLD TEXT**

Italic:

To make your text italic simply add 1 astrix before and after.

*Italic Text*

Bullet Points:

To do bullet points in .md files. Simply do - at the start of the line.

- My Bullet Point.... 

Blockquote:

To do blockquote in .md files. Simply do > at the start of the line.

> My blockquote 

To link something in .md files do: [Text](link with https://)

Code:

To code in .md files. Do ` before and after.

`print("hi")`
For multiple lines of code do 3 `.

Headings:

To add a heading simply add a hashtag before the heading.

# Heading 

You can do sub-titles by adding an extra hashtag.

# Heading
## Heading 2 
### Heading 3

Horizontal Line:

To add a break line oor etc in .md files. Do ---.

Text 

--- 

More Text 

Images:

To add a image to your .md files. Simply do:

![Inset Alt Text Here](Insert Image File Name Here)

Tables:

To add a image to your .md files. Simply do:

| Syntax | Description |
| ----------- | ----------- |
| Header | Title |
| Paragraph | Text |

Footnotes:

To add footnotes to your .md files. Simply do:

Here's a sentence with a footnote. [^1]

[^1]: This is the footnote.

Subscript & Superscript:

To add Subscript to your .md files. Simply do:

H~2~O

To add superscipt to your .md files. Simply do:

X^2^

Highlight:

To highlight text in your .md files. Simply add two equal sings before and after.

==Highlighted text== 

Admonitions:

In addition to the basic Markdown syntax. You can have a special admonitions syntax by wrapping text with a set of 3 colons, followed by a label denoting its type.

:::note

This feature is AMAZING! 

:::

Note

When contributing to the IndiSpark Documentation. This method does not work. Click Here