Markdown

Markdown Editor

We will use 'Typora' as the offline Markdown editor.

Also, you can use NOTION app

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:

  • Comments in Issues and Pull Requests

  • Files with the .md or .markdown extension: README.md

Syntax guide

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

Headers

Emphasis

Unordered List

Ordered List

Images

Blockquotes

Inline code

Block code

Examples

There are many different ways to style code with GitHub’s 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:

GitHub also supports something called code fencing, which allows for multiple lines without indentation:

And if you’d like to use syntax highlighting, include the language:

Reference

Last updated

Was this helpful?