License Note: Derivated from "Markdown Cheatsheet" by Adam Pritchard, used under CC-BY. This file is also licensed under CC-BY.
This is intended as a quick reference and showcase. For more complete info, see John Gruber's original spec and the Github-flavored Markdown info page.
Headers
Emphasis
Lists
Links
Images
Code and Syntax Highlighting
Tables
Blockquotes
Inline HTML
Horizontal Rule
Line Breaks
Task Lists
Emojis
Mentioning other people
Referencing issues and pull requests
# H1
## H2
### H3
#### H4
##### H5
###### H6
Alternatively, for H1 and H2, an underline-ish style:
Alt-H1
======
Alt-H2
------
Alternatively, for H1 and H2, an underline-ish style:
Emphasis, aka italics, with *asterisks* or _underscores_.
Strong emphasis, aka bold, with **asterisks** or __underscores__.
Combined emphasis with **asterisks and _underscores_**.
Strikethrough uses two tildes. ~~Scratch this.~~
Emphasis, aka italics, with asterisks or underscores.
Strong emphasis, aka bold, with asterisks or underscores.
Combined emphasis with asterisks and underscores.
Strikethrough uses two tildes. Scratch this.
(In this example, leading and trailing spaces are shown with with dots: ⋅)
1. First ordered list item
2. Another item
⋅⋅⋅* Unordered sub-list.
1. Actual numbers don't matter, just that it's a number
⋅⋅⋅1. Ordered sub-list
5. And another item.
⋅⋅⋅⋅You can have properly indented paragraphs within list items. Notice the blank line above, and the leading spaces (at least one, but we'll use three here to also align the raw Markdown).
* Unordered list can use asterisks
- Or minuses
+ Or pluses
-
First ordered list item
-
Another item
- Unordered sub-list.
-
Actual numbers don't matter, just that it's a number
- Ordered sub-list
-
And another item.
You can have properly indented paragraphs within list items. Notice the blank line above, and the leading spaces (at least three, and max six, otherwise you get an intended codeblock).
- Unordered list can use asterisks
- Or minuses
- Or pluses
There are two ways to create links.
[I'm an inline-style link](https://www.gepardec.com/)
[I'm an inline-style link with title](https://www.gepardec.com/ "Gepardec's Homepage")
[I'm a reference-style link][Arbitrary case-insensitive reference text]
[You can use numbers for reference-style link definitions][1]
Or leave it empty and use the [link text itself].
URLs and URLs in angle brackets will automatically get turned into links.
http://www.example.com or <http://www.example.com>
Some text to show that the reference links can follow later.
[arbitrary case-insensitive reference text]: https://www.gepardec.com/
[1]: https://www.gepardec.com/
[link text itself]: https://www.gepardec.com/
I'm an inline-style link with title
You can use numbers for reference-style link definitions
Or leave it empty and use the link text itself.
URLs and URLs in angle brackets will automatically get turned into links. http://www.example.com or http://www.example.com
Some text to show that the reference links can follow later.
When writing a README.md you can also refer to relative items in your repository:
A relative link is a link that is relative to the current file. For example, if you have a README file in root of your repository, and you have another file in docs/CONTRIBUTING.md, the relative link to CONTRIBUTING.md in your README might look like this:
[Contribution guidelines for this project](docs/CONTRIBUTING.md)see: https://help.github.com/en/github/writing-on-github/basic-writing-and-formatting-syntax
Here's our logo (hover to see the title text):
Inline-style:
Reference-style:
![alt text][logo]
[logo]: https://raw.githubusercontent.com/csalmhof/branding/master/logo/gepardec173x48.png "Logo Title Text 2"
Here's our logo (hover to see the title text):
Inline-style:
Reference-style:
Code blocks are part of the Markdown spec, but syntax highlighting isn't. However, many renderers -- like Github's support syntax highlighting. Which languages are supported and how those language names should be written will vary from renderer to renderer.
Inline `code` has `back-ticks around` it.
Inline code has back-ticks around it.
Blocks of code are either fenced by lines with three back-ticks ```, or are indented with four spaces. I recommend only using the fenced code blocks -- they're easier and only they support syntax highlighting.
```javascript
var s = "JavaScript syntax highlighting";
alert(s);
```
```java
public class JavaHighlighting{
public static void main(String args[]){
System.out.println("Java syntax highlighting");
}
}
```
```python
s = "Python syntax highlighting"
print s
```
```
No language indicated, so no syntax highlighting.
But let's throw in a <b>tag</b>.
```
var s = "JavaScript syntax highlighting";
alert(s);public class JavaHighlighting{
public static void main(String args[]){
System.out.println("Java syntax highlighting");
}
}s = "Python syntax highlighting"
print sNo language indicated, so no syntax highlighting.
But let's throw in a <b>tag</b>.
Colons can be used to align columns.
| Tables | Are | Cool |
| ------------- |:-------------:| -----:|
| col 3 is | right-aligned | $1600 |
| col 2 is | centered | $12 |
| zebra stripes | are neat | $1 |
There must be at least 3 dashes separating each header cell.
The outer pipes (|) are optional, and you don't need to make the
raw Markdown line up prettily. You can also use inline Markdown.
Markdown | Less | Pretty
--- | --- | ---
*Still* | `renders` | **nicely**
1 | 2 | 3
Colons can be used to align columns.
| Tables | Are | Cool |
|---|---|---|
| col 3 is | right-aligned | $1600 |
| col 2 is | centered | $12 |
| zebra stripes | are neat | $1 |
There must be at least 3 dashes separating each header cell.
The outer pipes (|) are optional, and you don't need to make the raw Markdown line up prettily. You can also use inline Markdown.
| Markdown | Less | Pretty |
|---|---|---|
| Still | renders |
nicely |
| 1 | 2 | 3 |
> Blockquotes are very handy useful to represent quotes that are no code.
> This line is part of the same quote.
Quote break.
> This is a very long line that will still be quoted properly when it wraps. Oh boy let's keep writing to make sure this is long enough to actually wrap for everyone. Oh, you can *put* **Markdown** into a blockquote.
> You can also nest Blockquotes
> > This is the nested quoteblock
Blockquotes are very handy useful to represent quotes that are no code. This line is part of the same quote.
Quote break.
This is a very long line that will still be quoted properly when it wraps. Oh boy let's keep writing to make sure this is long enough to actually wrap for everyone. Oh, you can put Markdown into a blockquote.
You can also nest Blockquotes
This is the nested quoteblock
You can also use raw HTML in your Markdown, and it'll mostly work pretty well.
<dl>
<dt>Definition list</dt>
<dd>Is something people use sometimes.</dd>
<dt>Markdown in HTML</dt>
<dd>Does *not* work **very** well. Use HTML <em>tags</em>.</dd>
</dl>
- Definition list
- Is something people use sometimes.
- Markdown in HTML
- Does *not* work **very** well. Use HTML tags.
Three or more...
---
Hyphens
***
Asterisks
___
Underscores
- - -
Or put scaces between them
* * *
Three or more...
Hyphens
Asterisks
Underscores
Or put scaces between them
My basic recommendation for learning how line breaks work is to experiment and discover -- hit Enter once, then hit it twice (i.e., insert newlines), see what happens. You'll soon learn to get what you want.
Here are some things to try out:
Here's a line for us to start with.
This line is separated from the one above by two newlines, so it will be a *separate paragraph*.
This line is also a separate paragraph, but...
This line is only separated by a single newline, so it will write be written in the same line cause its in the *same paragraph*.
If you want a linebreak in an paragraph, make a `<br>`-Tag at the point you want to insert the linebreak.<br>
This line is in the same parapraph but a linebreak was added
Another option to make a linebreak without starting a new paragraph is to add two spaces at the end of the first line (shown as dots(⋅) here.⋅⋅
This line is also in the same paragraph but a linebreak was added
Here's a line for us to start with.
This line is separated from the one above by two newlines, so it will be a separate paragraph.
This line is also a separate paragraph, but... This line is only separated by a single newline, so it will write be written in the same line cause its in the same paragraph.
If you want a linebreak in an paragraph, make a <br>-Tag at the point you want to insert the linebreak.
This line is in the same parapraph but a linebreak was added
Another option to make a linebreak without starting a new paragraph is to add two spaces at the end of the first line (shown as dots(⋅) here.⋅⋅ This line is also in the same paragraph but a linebreak was added
Task Lists are very useful to create a List of things which needs to be done.
- [x] This is an finished Task
- [ ] This is an unfinished Task
- [ ] It would not work without text behind the Brackets.
- This is an finished Task
- This is an unfinished Task
- It would not work without text behind the Brackets.
It is also possible to add emojis. Just type : in the textfield in GitHub and it will propose you emojis.
Lets give some thumbs-up: :+1:
I think everybody likes :cat: but some people prefer :dog:.
Lets give some thumbs-up: 👍
I think everybody likes 🐱 but some people prefer 🐶.
When you are working together with other developers on GitHub this is a nice tool to remember people on something or to ask for their opinion. They will get an notification when they are mentioned. (e.g. when commenting on an issue)
For example:
@csalmhof Please do not commit such messy code
Use the #-sign to reference an issue or pull request by number:
For example:
This paragraph belongs to Issue #15