Skip to content

Latest commit

 

History

History
253 lines (189 loc) · 3.76 KB

mastering_markdown.md

File metadata and controls

253 lines (189 loc) · 3.76 KB

Mastering Markdown

In a markdown file on GitHub, to see how it was formatted, click on "raw" on upper right corner.

Table of Contents

1. Text Formatting
2. Headers
3. Line Breaks
4. Links
5. Inline Code
6. Images
7. Emojis
8. Tables

1. Text Formatting

bold: **bold** bold
italic: *italic* italic
italic: _italic_ italic
strikethrough: ~~strike thru~~ cross out

2. Headers

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

Header 1

Header 2

Header 3

Header 4

Header 5
Header 6

3. Line Breaks

How to add line breaks:

  1. can enclose text in triple back quotes
  2. add two spaces to end of line

4. Links

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

results in:
Google website

5. Inline Code

`text`

text

6. Images

Format: ![Alt Text](url)

![Ben Franklin quote](images/ben_franklin_teach.jpg)

Ben Franklin

7. Emojis

typing this:

:smiley:

results in:
😃

8. Tables in Markdown

First Header | Second Header
------------ | -------------
Content from cell 1 | Content from cell 2
Content in the first column | Content in the second column
First Header Second Header
Content from cell 1 Content from cell 2
Content in the first column Content in the second column

Bullet Points

Fruit Types I

  • apple
  • banana
  • pear

Fruit Types I

  • apple
  • banana
  • pear

Fruit Types II

  • apple
  • banana
  • pear

Fruit Types III

  1. apple
  2. banana
  3. pear

Produce

  • fruit
    • apple
    • banana
    • orange
  • vegetable
    • carrot
    • celery
    • onion

Checklist

  • @mentions, #refs, links, formatting, and tags supported
  • list syntax required (any unordered or ordered list supported)
  • this is a complete item
  • this is an incomplete item

Block Code, Language-specific

python

Block code that is non-specific:

print "hello world!"
print "hello moon"

Block code that is python-specific:

print "hello world!"
print "hello moon"

bash or console

Block code that is non-specific:

$ git status
$ git remote -v

Block code that is bash-specific:

$ git status
$ git remote -v

$ ps awx | grep mongo

SQL

Block code that is non-specific:

SELECT * FROM Customers WHERE Country='Sweden';

Block code that is sql-specific:

SELECT * FROM Customers WHERE Country='Sweden';

Yes, this works for scores of other languages: Syntax highlighting in markdown

Tables II

<h1 > test </h1>
<p> xxxxxxxxx
xxxxxxxxx</p>
<table>
    <tr>
        <td>Foo</td>
    </tr>
        <tr>
        <td>Foo</td>
    </tr>
</table>

test

xxxxxxxxx xxxxxxxxx

Foo Foo Foo
Foo

Indenting

indent at one level

indent at two levels

text, test, test, test, test

print "hello world!"

print "hello" world

print "hello world!"

<p>printing a paragraph in HTML! </p>