Markdown

parent:: Knowledge Management

Markdown is a simple way to format text that looks great on any device. It doesn’t do anything fancy like change the font size, colour, or type — just the essentials, using keyboard symbols you already know.

Headings: Putting a # in front of a text with a space makes it a heading.

Heading 1

Heading 2

Heading 3

Heading 4

Heading 5

Heading 6

Bold: Enclosing the text in ** ** ⇒ This leads to bold text Italics: Enclosing the text in * * ⇒ This leads to italic text links : Enclosing the text in ⇒ links #Tags : Putting # without the space makes it a tag for filtering and searching through the text nodes.

Lists

Unordered Lists

• Bold: Enclosing the text in ** ** ⇒ This leads to bold text
• Italics: Enclosing the text in * * ⇒ This leads to italic text

Ordered Lists

1. Bold: Enclosing the text in ** ** ⇒ This leads to bold text
2. Italics: Enclosing the text in * * ⇒ This leads to italic text

Markdown in GitHub

• In Readme file in github to add spaces use unicode character
• No styles or script can be added in github readme or markdown (Alternative :Css-in-readme: Style your readme using CSS with this simple trick)
• To embed image there are currently three following tricks
  • Embed the file local to the repository
  • Embed the remote server file using url (See: Wikimedia Commons )
  • Store the file in one of the issues of github and then use the url
  • Alternatively you can use the url from the main repository of the project image you wanna embed.
  • Now we can also upload the images to github directly too by drag and drop feature.

Related

• how to add rupees symbol in html and markdown formatting queries

References:: https://commonmark.org/

Tags:: markdown guides tools

Back-links::