Markdown: A Comprehensive Guide for Creating Formatted Text on GitHub, Study notes of Advanced Computer Programming

Explore the basics of markdown syntax for formatting text on github, including headers, emphasis, images, links, lists, user mentions, tables, and more. Learn how to create code blocks, use emojis, and reference issues.

Typology: Study notes

2021/2022

Uploaded on 07/05/2022

paul.kc
paul.kc 🇦🇺

4.7

(68)

1K documents

1 / 2

Toggle sidebar

This page cannot be seen from the preview

Don't miss anything!

bg1
BLOCKQUOTES
As Kanye West said:
> We're living the future so
> the present is our past.
As Kanye We st said:
We're living t he futu re so
the pres ent is our p ast.
LISTS
Unordered
Ordered
* Item 1
* Item 2
* Item 2a
* Item 2b
1. Item 1
2. Item 2
3. Item 3
* Item 3a
* Item 3b
BACKSLASH ESCAPES
\*literal asterisks\*
*literal asterisks*
Markdow n allows you t o use backs lash esca pes to
generate literal characters which would otherwise
have spec ial meanin g in Markdo wn’s form atting
syntax.
Markdow n provide s backsla sh escape s for the
following characters:
\ backslash
` backtick
* asterisk
_ underscore
{} curly braces
[] square brackets
() parentheses
# hash mark
+ plus si gn
- minu s sign (hyp hen)
. dot
! exclamation mark
MARKDOWN
SYNTAX
Markdown is a way to style tex t on
the web. You control the display o f
the documen t; formatting words as
bold or italic, adding i mages, and
creating list s are just a few of the
things we can do w ith Markdown.
Mostly, Markdown is ju st regular text
with a few non-a lphabetic character s
thrown in, li ke # or *.
HEADERS
# This is an <h1> tag
## This is an <h2> tag
###### This is an <h6> tag
EMPHASIS
*This text will be italic*
_This will also be italic_
**This text will be bold**
__This will also be bold__
*You **can** combine them*
IMAGES
![GitHub Logo](/images/logo.png)
Format: ![Alt Text](url)
LINKS
http://github.com - automatic!
[GitHub](http://github.com)
pf2

Partial preview of the text

Download Markdown: A Comprehensive Guide for Creating Formatted Text on GitHub and more Study notes Advanced Computer Programming in PDF only on Docsity!

B L O C K Q U O T E S

As Kanye West said:

> We're living the future so > the present is our past.

As Kanye West said:

We're living the future so the present is our past.

L I S T S

Unordered

Ordered

  • Item 1
  • Item 2
  • Item 2a
  • Item 2b
  1. Item 1
  2. Item 2
  3. Item 3
    • Item 3a
    • Item 3b

B A C K S L A S H E S C A P E S

*literal asterisks*

literal asterisks

Markdown allows you to use backslash escapes to generate literal characters which would otherwise have special meaning in Markdown’s formaing syntax.

Markdown provides backslash escapes for the following characters:

\ backslash ` backtick

  • asterisk _ underscore {} curly braces [] square brackets

() parentheses

hash mark

  • plus sign
  • minus sign (hyphen) . dot ! exclamation mark

M A R K D O W N

S Y N TA X

Markdown is a way to style text on the web. You control the display of the document; formaing words as bold or italic, adding images, and creating lists are just a few of the things we can do with Markdown. Mostly, Markdown is just regular text with a few non-alphabetic characters thrown in, like # or *.

H E A D E R S

This is an tag

This is an tag

This is an tag

E M P H A S I S

This text will be italic This will also be italic

This text will be bold This will also be bold

You can combine them

I M A G E S

Format:

L I N K S

http://github.com - automatic!

GitHub

TA S K L I S T S

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

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

U S E R N A M E  M E N T I O N S TA B L E S

First HeaderSecond Header Content cell 1Content cell 2 Content column 1Content column 2

First Header Second Header Content cell 1 Content cell 2 Content column 1 Content column 2

G I T H U B

F L AV O R E D

M A R K D O W N

Typing an @ symbol, followed by a username, will notify that person to come and view the comment. This is called an “@mention”, because you’re mentioning the individual. You can also @mention teams within an organization.

You can create tables by assembling a list of words and dividing them with hyphens - (for the first row), and then separating each column with a pipe | :

F E N C E D C O D E B L O C K S

function test() { console.log("look ma`, no spaces"); }

Markdown coverts text with four leading spaces into a code block; with GFM you can wrap your code with ``` to create a code block without the leading spaces. Add an optional language identifier and your code with get syntax highlighting.

E M O J I

To see a list of every image we support, check out www.emoji-cheat-sheet.com

I S S U E R E F E R E N C E S

Any number that refers to an Issue or Pull Request will be automatically converted into a link.

defunkt# defunkt/github-flavored-markdown#

GitHub supports emoji! :+1: :sparkles: :camel: :tada: :rocket: :metal: :octocat:

GitHub supports emoji!

GitHub.com uses its own version of the Markdown syntax that provides an additional set of useful features, many of which make it easier to work with content on GitHub.com.

function test() { console.log("look ma`, no spaces"); }