jspsv

GitHub Flavored Markdown (GFM)

2019-10-01

recepies
Full example of GFM

Basic writing and formatting syntax. Create sophisticated formatting for your prose and code on GitHub with simple syntax.

GFM according to github.

List of Features
  1. Headings
  2. Styling text
  3. Quoting text
  4. Quoting code
  5. Links
  6. Images
  7. Lists
  8. Footnotes
  9. Collapsed section
  10. Math expressions
  11. Creating digrams

Headings

H1

H2

H3

H4

H5
H6

Styling text

Style Example
Bold This is bold text
Italic This text is italicized
Strikethrough This was mistaken text
Bold and nested italic This text is extremely important
All bold and italic All this text is important
Subscript This is a subscript text
Superscript This is a superscript text

Quoting text

Text that is not a quote

Text that is a quote

Quoting code

Use git status to list all new or modified files that haven’t yet been committed.

Some basic Git commands are:

git status
git add
git commit

The background color should be #ffffff for light mode and #0d1117 for dark mode.

Style Example
HEX #0969DA
RGB rgb(9, 105, 218)
HSL hsl(212, 92%, 45%)

This site was built using GitHub pages.

Footnotes

Here is a simple footnote[^1].

A footnote can also have multiple lines[^2].

You can also use words, to fit your writing style more closely[^note].

[^1]: My reference. [^2]: Every new line should be prefixed with 2 spaces.
This allows you to have a footnote with multiple lines.

[^note]: Named footnotes will still render with numbers instead of the text but allow easier identification and linking.
This footnote also has been made with a different syntax using 4 spaces for new lines.

Images

Lists

  • George Washington
  • John Adams
  • Thomas Jefferson
    • First nested list item
      • Second nested list item
  1. James Madison
  2. James Monroe
  3. John Quincy Adams
    1. First nested list item
      1. Second nested list item

Collapsed section

Collapsed section
puts "Hello World"

Math expressions

  • Use \$ to use $ sign directly, for example: \$100.

Writing expressions as blocks

The Cauchy-Schwarz Inequality

Creating diagrams

digraph example1 {
    1 -> 2 -> { 4, 5 };
    1 -> 3 -> { 6, 7 };
}