Skip to content

Latest commit

 

History

History
154 lines (90 loc) · 2.06 KB

README.md

File metadata and controls

154 lines (90 loc) · 2.06 KB

Markdown

What is markdown ? Markdown is a lightweight markup language with plain text formatting syntax.

Why use markdown ? Markdown is one of the best way to create a notes or documentation about anything. Yes, anything!

It's a text format that usually has .md or .markdown file extension.

Heading Example

# Heading 1

## Heading 2

### Heading 3

Output

Heading 1

Heading 2

Heading 3

Text styling example

**bold** and _italic_

Output:

bold and italic

Create list example

* First
* Second
* Third

or

1.  One
2.  Two
3.  Three

Output:

  • First
  • Second
  • Third

or

  1. One
  2. Two
  3. Three

Create link example

[Google](https://google.com)

Output:

Google

Hello Markdown

All of these learning materials are built using Markdown format.

Let's see what's a complete README looks like.

To create a Markdown page, create an index.md or hello.md file in your editor. Then input the Markdown syntax.

Code:

# Impact Todo

**Impact Todo** is a simple todo app for everyone.

You can [access it here live](https://impactodo.netlify.com).

## Features

* Create todo
* Read todo
* Delete todo

## License

See [LICENSE](./LICENSE.md)

Result:

Impact Todo

Impact Todo is a simple todo app for everyone.

You can access it here live.

Features

  • Create todo
  • Read todo
  • Delete todo

License

See LICENSE

Tips

To make your Markdown file better, use this Remark extension.

Project

Create README.md file that contains documentation: