Skip to content

A comprehensive guide to mastering Markdown. Open to contributions and updates.Contribute, learn, and share. Let's make documentation beautiful together!

License

Notifications You must be signed in to change notification settings

bongdevhq/MarkItDownGuide

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

MarkItDownGuide GitHub contributors

A comprehensive guide to mastering Markdown. Open to contributions and updates. Contribute, learn, and share. Let's make documentation beautiful together!

Markdown Language Tutorial

1. Headings

Markdown Code:

'# Heading 1
## Heading 2
### Heading 3
#### Heading 4
##### Heading 5
###### Heading 6 '

Output:

Heading 1

Heading 2

Heading 3

Heading 4

Heading 5
Heading 6

2. Bold

Markdown Code:

`**Bold Text**'

Output: Bold Text

3. Italic

Markdown Code:


`*Italic Text*` 

Output: Italic Text

4. Bold and Italic

Markdown Code:


`***Bold and Italic Text***` 

Output: Bold and Italic Text

5. Strikethrough Text

Markdown Code:


`~~Strikethrough Text~~` 

Output: Strikethrough Text

6. Unordered List of Items

Markdown Code:


`- Item 1
- Item 2
 - Subitem 2.1
 - Subitem 2.2` 

Output:

  • Item 1
  • Item 2
    • Subitem 2.1
    • Subitem 2.2

7. Ordered List of Items

Markdown Code:


`1. First Item
2. Second Item
3. Third Item` 

Output:

  1. First Item
  2. Second Item
  3. Third Item

8. CheckBox Task List

Markdown Code:


`- [x] Completed Task
- [ ] Incomplete Task` 

Output:

  • Completed Task
  • Incomplete Task

9. Blockquote Text

Markdown Code:


`> Blockquote Text` 

Output:

Blockquote Text

10. Link

Markdown Code:


`[Google](https://www.google.com)` 

Output: Google

11. Image

Markdown Code:


`![Alt Text](https://via.placeholder.com/150)` 

Output: Alt Text

12. Linking an Image

Markdown Code:


`[![Alt Text](https://via.placeholder.com/150)](https://www.google.com)` 

Output: Alt Text

13. Emojis

Markdown Code:


`:smile:` 

Output: 😄

14. Horizontal Line

Markdown Code:


`---` 

Output:

15. Code

Markdown Code:


`` `Inline Code` `` 

Output: Inline Code

16. Code Block

Markdown Code: `

Another Line of Code 

**Output:**


`Code Block
Another Line of Code` 

### 17. Table

**Markdown Code:**



| Header 1 | Header 2 |
|----------|----------|
| Cell 1   | Cell 2   |
| Cell 3   | Cell 4   |` 

**Output:**

| Header 1 | Header 2 |
|----------|----------|
| Cell 1   | Cell 2   |
| Cell 3   | Cell 4   |` 

### 18. Table With Alignments

**Markdown Code:**



| Left Align | Center Align | Right Align |
|:-----------|:------------:|------------:|
| Cell 1     | Cell 2       | Cell 3      |


**Output:**

| Left Align | Center Align | Right Align |
|:-----------|:------------:|------------:|
| Cell 1     |    Cell 2    |      Cell 3 |


### 19. HTML

**Markdown Code:**


`<b>Bold Text using HTML</b>` 

**Output:** <b>Bold Text using HTML</b>

### 20. Embed YouTube Video

**HTML Code:**

<iframe width="560" height="315" src="https://www.youtube.com/embed/VIDEO_ID" frameborder="0" allowfullscreen></iframe> ```

21. Mathematical Expressions

Markdown Code:


`$$ E = mc^2 $$` 

Output: $$ E = mc^2 $$

22. DropDown (Using HTML)

HTML Code:


`<details>
  <summary>Title</summary>
  Content here...
</details>` 

Output:

Title Content here...

23. Diagrams

Markdown itself doesn't support diagrams. You'll need third-party tools or extensions for this. However, some platforms and tools have integrated services like Mermaid or PlantUML to allow for diagram rendering within Markdown. Here's an example using Mermaid syntax:

mermaid graph TD; A-->B; A-->C; B-->D; C-->D;

(Note: The actual rendering of the diagram will depend on the platform's support for Mermaid or other diagram tools.)

For platforms that don't support Mermaid or similar tools, you might need to generate the diagram externally, save it as an image, and then embed the image in your Markdown document.

24. FootNote

Markdown Code:


`Here's a statement[^1].

[^1]: This is the footnote.` 

Output: Here's a statement1(About us bong.dev - Unite, Learn and Code).

25. Comments

Markdown Code:


`[//]: # (This is a comment.)` 

Output: [//]: # (This is a comment.)

26. Nested Blockquotes

You can nest blockquotes by adding additional > characters.

Markdown Code:


`> First Level
>> Second Level
>>> Third Level` 

Output:

First Level

Second Level

Third Level

27. Inline HTML

You can use any HTML tag inline with your Markdown.

Markdown Code:


`This is <span style="color:red">red</span> text.` 

Output: This is red text.

28. Escaping Characters

If you want to display a character that has a special meaning in Markdown, you can escape it with a backslash (\).

Markdown Code:


`\*This is not italic\*` 

Output: This is not italic

29. Reference Links

You can define links and then reference them elsewhere in your document for cleaner Markdown.

Markdown Code:


`[Google][1]
[GitHub][2]

Output: Google GitHub

30. Reference Images

Just like reference links, but for images.

Markdown Code:


`![Alt Text][image1]

[image1]: https://via.placeholder.com/150` 

Output: Alt Text

31. Abbreviations

Define abbreviations that will show an explanation when hovered over.

Markdown Code (requires specific Markdown parsers like PHP Markdown Extra):


`The HTML specification is maintained by the W3C.

*[HTML]: Hyper Text Markup Language
*[W3C]: World Wide Web Consortium` 

Output: The HTML specification is maintained by the W3C.

*[HTML]: Hyper Text Markup Language *[W3C]: World Wide Web Consortium

32. Definition Lists

Create a list of terms with their corresponding definitions.

Markdown Code (requires specific Markdown parsers like PHP Markdown Extra):


`Apple
:   A fruit that is red or green.

Orange
:   A juicy citrus fruit.` 

Output: Apple : A fruit that is red or green. Orange : A juicy citrus fruit.

33. Line Breaks

To create a line break, end a line with two or more spaces, then type return.

Markdown Code:


`This is the first line.  
This is the second line.` 

Output: This is the first line.
This is the second line.

34. DropDown (Using HTML)

Markdown itself doesn't directly support dropdowns, but you can use HTML within your Markdown to achieve this.

<details> <summary>Click to expand!</summary>

Content inside the dropdown.

</details> 
Click to expand!

Content inside the dropdown.

35. Defination Lists:

Markdown Code

Term 1
: Give defination for first term.

Term 2
: Give definition for second term.

Output:

Term 1 : Give defination for first term.

Term 2 : Give definition for second term.

36. Suppressed Markdowns:

Markdown Code

\*This won't be* **parsed as** [Markdown].: *This won't be* parsed as [Markdown].

37. Superscript and Subscript (Using HTML):

H<sub>2</sub>0 is a chemical formula.: H20 is a chemical formula.

X<sup>2</sup> is an exponent.: X2 is an exponent.

38. Syntax Highlighting:

Follow the mentioned syntax in markdown code:

python

def syntax_highlighting():

print("Highlighted code")

def syntax_highlighting():
    print("Highlighted code")

39. Inline Footnotes:

Markdown Code

Here's some text with a footnote about what I love very much[^1].

[^1]: This is the footnote that says I love Music.

Here's some text with a footnote about what I love very much1.

40. Blockquotes with Citation:

Markdown Code

> This is a blockquote.
> -- Alpha Mango.


This is a blockquote. -- Alpha Mango.

41. Nested Lists with Different Bullet Types:

Markdown Code

- Item 1
  - Subitem 1
    - Subsubitem 1
- Item 2
  • Item 1
    • Subitem 1
      • Subsubitem 1
  • Item 2

42 Inline Math Equations with LaTeX:

Markdown Code

This is an inline math equation(identity): $e^{i\pi} + 1 = 0$

This is an inline math equation(identity): $e^{i\pi} + 1 = 0$

43. Task Lists:

Markdown Code:

- [x] Task 1
- [ ] Task 2
  • Task 1 =Completed
  • Task 2 =Pending

44. Ordered List with Custom Start Number:

Markdown Code

10. Item 1
20. Item 2
30. Item 3
  1. Item 1
  2. Item 2
  3. Item 3

45. Tables with Complex Structures:

Markdown Code

| Student       | Subject         | Grade |
| ------------- | --------------- | ----- |
| Alice         | Math            | A     |
|               | Physics         | B     |
|               | Chemistry       | A     |
| ------------- | --------------- | ----- |
| Bob           | Math            | B     |
|               | Physics         | A     |
|               | Chemistry       | B     |
|               | Biology         | C     |
| ------------- | --------------- | ----- |
| Carol         | Math            | A     |
|               | Physics         | A     |
|               | Chemistry       | A     |
| ------------- | --------------- | ----- |
| David         | Math            | C     |
|               | Physics         | B     |
|               | Chemistry       | B     |
| ------------- | --------------- | ----- |

Student Subject Grade
Alice Math A
Physics B
Chemistry A
------------- --------------- -----
Bob Math B
Physics A
Chemistry B
Biology C
------------- --------------- -----
Carol Math A
Physics A
Chemistry A
------------- --------------- -----
David Math C
Physics B
Chemistry B
------------- --------------- -----

We also can use Nested lists too

| Student       | Subjects                                            | Grades       |
| ------------- | --------------------------------------------------- | ------------ |
| Alice         | - Math<br>   - Algebra<br>   - Geometry             | A<br>   B<br>   A |
| Bob           | - Math<br>   - Physics<br>   - Chemistry<br>   - Biology | B<br>   A<br>   B<br>   C |
| Carol         | - Math<br>   - Physics<br>   - Chemistry           | A<br>   A<br>   A |
| David         | - Math<br>   - Physics<br>   - Chemistry           | C<br>   B<br>   B |
Student Subjects Grades
Alice - Math
- Algebra
- Geometry
A
B
A
Bob - Math
- Physics
- Chemistry
- Biology
B
A
B
C
Carol - Math
- Physics
- Chemistry
A
A
A
David - Math
- Physics
- Chemistry
C
B
B

46. Complex Nexting:

- Item 1
  - Subitem A
    1. Numbered Sub-subitem
    2. Another Numbered Sub-subitem
  - Subitem B
- Item 2
  • Item 1
    • Subitem A
      1. Numbered Sub-subitem
      2. Another Numbered Sub-subitem
    • Subitem B
  • Item 2

47. Combining Emphasis and Links:

Markdown Code

My favourite book currently is **[An Introduction to *Statistical Learning*](https://www.statlearning.com/)**.

My favourite book currently is An Introduction to Statistical Learning.

48. Nested Inline Code:

Markdown Code

This is an example of `inline code with` nested `backticks`.

This is an example of inline code with nested backticks.

49. Definition Lists with Nested Lists:

Markdown Code

Term 1
: Definition 1
  - Sub-definition 1
  - Sub-definition 2

Term 2
: Definition 2
  - Sub-definition 3

Term 1 : Definition 1

  • Sub-definition 1
  • Sub-definition 2

Term 2 : Definition 2

  • Sub-definition 3

50. Combining Lists and Tables:

Markdown Code

- Item 1
  | Header 1 | Header 2 |
  | -------- | -------- |
  | Cell 1   | Cell 2   |
- Item 2
  • Item 1
    Header 1 Header 2
    Cell 1 Cell 2
  • Item 2

Footnotes

  1. This is the footnote that says I love Music.