Markdown Guide
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 *.
Note : you can use basic HTML inside markdown. Tags for text formatting, like
<u>and<bold>will work
Here’s an overview of Markdown syntax that you can use on coderplex.org posts, updates etc.
# This is an <h1> tag
## This is an <h2> tag
###### This is an <h6> tag
*This text will be italic*
_This will also be italic_
**This text will be bold**
__This will also be bold__
_You **can** combine them_
Unordered
* Item 1
* Item 2
* Item 2a
* Item 2b
Ordered
1. Item 1
1. Item 2
1. Item 3
1. Item 3a
1. Item 3b
Format: 
http://coderplex.org - automatic!
[Coderplex Community](http://coderplex.org)
As Kanye West said:
> We're living the future so
> the present is our past.
I think you should use an
`<addr>` element here instead.
We also support some popular embeds out of the box. You can embed these in the following way.
<CodePen id="PNaGbb" />
<Gist id="PaulieScanlon/ca0cc9239176066492cb2aba435edbf7" />
<Tweet id="pbteja1998/status/1363815059563061251" />
<YouTube id="WUgvvPRH7Oc" />
<CodeSandbox id="react-new" />
<Repl id="@BhanuTejaTeja2/Buttons" />
<Glitch id="thingproxy" />Input : It's very easy to make some words **bold** and other words *italic* with Markdown. You can even [link to Google!](http://google.com)
Output : It's very easy to make some words bold and other words italic with Markdown. You can even link to Google!
Input :
Sometimes you want numbered lists:
1. One
2. Two
3. Three
Sometimes you want bullet points:
* Start a line with a star
* Profit!
Alternatively,
- Dashes work just as well
- And if you have sub points, put two spaces before the dash or star:
- Like this
- And this
Output :
Sometimes you want numbered lists:
- One
- Two
- Three
Sometimes you want bullet points:
- Start a line with a star
- Profit!
Alternatively,
- Dashes work just as well
- And if you have sub points, put two spaces before the dash or star:
- Like this
- And this
Input :
If you want to embed images, this is how you do it:
Output :
If you want to embed images, this is how you do it:
Input :
# Structured documents
Sometimes it's useful to have different levels of headings to structure your documents. Start lines with a `#` to create headings. Multiple `##` in a row denote smaller heading sizes.
### This is a third-tier heading
You can use one `#` all the way up to `######` six for different heading sizes.
If you'd like to quote someone, use the > character before the line:
> Coffee. The finest organic suspension ever devised... I beat the Borg with it.
> - Captain Janeway
Output :
Sometimes it's useful to have different levels of headings to structure your documents. Start lines with a # to create headings. Multiple ## in a row denote smaller heading sizes.
You can use one # all the way up to ###### six for different heading sizes.
If you'd like to quote someone, use the > character before the line:
Coffee. The finest organic suspension ever devised... I beat the Borg with it.
- Captain Janeway
Input :
There are many different ways to style code with markdown. If you have inline code blocks, wrap them in backticks: `var example = true`. If you've got a longer block of code, you can indent with four spaces:
if (isAwesome){
return true
}
We also supports something called code fencing, which allows for multiple lines without indentation:
```
if (isAwesome){
return true
}
```
And if you'd like to use syntax highlighting, include the language:
```javascript
if (isAwesome){
return true
}
```
Output :
There are many different ways to style code with markdown. If you have inline code blocks, wrap them in backticks: var example = true. If you've got a longer block of code, you can indent with four spaces:
if (isAwesome){
return true
}
We also supports something called code fencing, which allows for multiple lines without indentation:
if (isAwesome){
return true
}
And if you'd like to use syntax highlighting, include the language:
if (isAwesome){
return true
}Input :
You can create task lists, using checkboxes, like below
- [x] This is a complete item
- [ ] This is an incomplete item
- [ ] This is another incomplete item
When you include a task list in the first comment of an Issue, you will see a helpful progress bar in your list of issues. It works in Pull Requests, too!
Output : You can create task lists, using checkboxes, like below
- This is a complete item
- This is an incomplete item
- This is another incomplete item
When you include a task list in the first comment of an Issue, you will see a helpful progress bar in your list of issues. It works in Pull Requests, too!