Skip to content

Markdown Guidelines

Dishank Tiwari edited this page Feb 5, 2019 · 4 revisions

Markdown is a lightweight and easy-to-use syntax for styling all forms of writing on the GitHub platform. 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 *.

Syntax Guide

Here’s an overview of Markdown syntax that you can use anywhere on GitHub.com or in your own text files.

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_

Lists

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

Images

![GitHub Logo]({% site.baseurl %}/images/logo.png)
Format: ![Alt Text](url)

Links

http://github.com - automatic!
[GitHub](http://github.com)

Blockquotes

As Kanye West said:

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

Horizonatal Rule

* * *

***

*****

- - -

---------------------------------------

Inline Code

I think you should use an
`<addr>` element here instead.

Syntax Highlighting

code type alias
HTML html
XML xml
SVG svg
CSS css
JAVASCRIPT javascript
PHP php
PYTHON python
RUBY ruby
PHP php
JAVA java
ASP.NET aspnet
C# csharp
Bash bash

example:

```javascript
console.log('Hello world')
```

Tables

| Tables        | Are           | Cool  |
| ------------- |:-------------:| -----:|
| col 3 is      | right-aligned | $1600 |
| col 2 is      | centered      |   $12 |
| zebra stripes | are neat      |    $1 |