Skip to content

harshilgajera-crest/gitmark

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 

Repository files navigation

gitmark

Frequently used GitHub Flavored Markdown (GFM)
Note: In most cases, you will need 2 spaces at the end of each line to create new line.


Table of Contents

  1. Lists
  2. Text Styles
  3. Other Useful Stuff

Lists

Unordered List

Use hyphens - or asterisks * for unordered list (both get same results)

using hyphens -

- This
- That
- Other

result:

  • This
  • That
  • Other

using asterisks *

* This
* That
* Other

result:

  • This
  • That
  • Other

Ordered List

Use Numbers or Letters for an Ordered list

Numbers

1. This
2. That
3. Other

result:

  1. This
  2. That
  3. Other

Letters

A. This
B. That
C. Other

result:

A. This
B. That
C. Other


Nested Ordered List

Make nested lists by indenting/tabbing over

1. This  
    a. item a  
2. That  
    b. item b  
3. Other  
    c. item c  

result:

  1. This
    a. item a
  2. That
    b. item b
  3. Other
    c. item c

Note: Dont forget 2 spaces at end of each line to make this work


Checkbox List

markup:

- [x] This  
- [ ] That  
- [ ] Other  

result:

  • This
  • That
  • Other

Expandable List

markup:

<details>
  <summary>Click to Expand</summary>  
  
  - Item 1  
  - Item 2  
  - Item 3  
      
</details>  

result:

Click to Expand
  • Item 1
  • Item 2
  • Item 3

Collapsible List (list already opened)

markup:

<details open>  

  <summary>Click to Collapse</summary>  
  
  - Item 1  
  - Item 2  
  - Item 3  
      
</details>  

result:

Click to Collapse
  • Item 1
  • Item 2
  • Item 3

Text Styles

Bold

Use 2 asterisks for bold

**This is Bold Text**

This is Bold Text


Italic

Use 1 asterisk for italic

*This is Italic Text*

This is Italic Text


Nested Italic within Bold

**This is *italic* within bold**

This is italic within bold


Strikethrough

This is ~~strikethrough~~

This is strikethrough


Subscript

This is <sub>subscript</sub>

This is subscript


Superscript

This is <sup>superscript</sup>

This is superscript


Headers

Use Hashtags # for Headers (1 thru 6)

# Header 1
## Header 2
### Header 3
#### Header 4
##### Header 5
###### Header 6

Other Useful Stuff

Horizontal Lines

3 hyphens, 3 asterisks, or 3 underscores

---  
***  
___  

result:




Quote Text

Quote text with a > symbol

> Line 1
> Line 2

result:

Line 1
Line 2


Quote Code

Quote code inside 3 backticks ```

```
**Bold Text markup**  
```

Bold Text markup


Notes and Warnings

> **Note**  
> Note to Self  
> **Warning**  
> Do not Disturb  

result:

Note
Note to Self

Warning
Do not Disturb


Footnotes8

Example markup:

The footnote is a bit of information    
or note about a topic in a reading.    
The footnote is connected by a     
reference number[^1] that corresponds     
with the same numbered footnote.    
Here, clicking the reference number  
directs us to the related footnote.  
The footnote gets its name[^2]     
because of its placement     
in the footer of a page.[^3]  


[^1]: Reference numbers are written in superscript.          

[^2]: As always, the footnote is placed in the footer, hence the name.          

[^3]: The footer is the margin at the bottom of the page usally containing information        
such as page numbers, copyrights, references, etc.        

result:

The footnote is a bit of information
or note about a topic in a reading.
The footnote is connected by a
reference number1 that corresponds
with the same numbered footnote.
Here, clicking the reference number
directs us to the related footnote.
The footnote gets its name2
because of its placement
in the footer of a page.3


Footnotes

  1. Reference numbers are written in superscript.

  2. As always, the footnote is placed in the footer, hence the name.

  3. The footer is the margin at the bottom of the page usally containing information
    such as page numbers, copyrights, references, etc.

About

Frequently used GitHub Markdown

Resources

License

Stars

Watchers

Forks

Packages

No packages published