Learning Markdown For Your Site

Jan 1, 2017


Markdown is a lightweight and easy-to-use syntax for styling all forms of writing on the GitHub platform.

What you will learn:

  1. How the Markdown format makes styled collaborative editing easy
  2. How Markdown differs from traditional formatting approaches
  3. How to use Markdown to format text
  4. How to leverage GitHub’s automatic Markdown rendering
  5. How to apply GitHub’s unique Markdown extensions

What is Markdown?

Markdown is a way to style text on the web. You control the display of the document; formatting 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 *.

You can use Markdown most places around GitHub:

  • Gists
  • Comments in Issues and Pull Requests
  • Files with the .md or .markdown extension

For more information, see “Writing on GitHub” in the GitHub Help.

Examples

Type to Get
*Italic* Italic
**Bold** Bold
[Link](http://a.com) Link
![Image](http://url/a.png) Image
> Blockquote > Blockquote
* List * List
Horizontal Rule Horizontal Rule
---

Headers

# H1
## H2
### H3
#### H4
##### H5
###### H6

H1

H2

H3

H4

H5
H6

Images

Here’s our logo (hover to see the title text):

Inline-style:

![alt text](https://github.com/adam-p/markdown-here/raw/master/src/common/images/icon48.png "Logo Title Text 1")

Reference-style: 
![alt text][logo]

alt text

Table structure

|Head1 | Head2 |
| ------ | ------ |
| test | test |
Head1 Head2
test test
|Head1 | Head2 | Head3 | Head4 | Head5 | Head6 |
| ------ | ------ | ------ | ------ | ------ | ------ |
| test | test | test | test | test | test |
Head1 Head2 Head3 Head4 Head5 Head6
test test test test test test

Markdown Cheatsheet, Markdown Guide


Learning Markdown For Your Site | Java Tutorial