Skip to main content

ReadMe's Markdown

João Amorim avatar
Written by João Amorim
Updated over 5 years ago

Markdown Overview

Almost every field on ReadMe supports GitHub Flavored Markdown.

You can learn about Markdown here: https://help.github.com/articles/markdown-basics/

You can learn about GitHub Flavored Markdown here: https://help.github.com/articles/github-flavored-markdown/

Special ReadMe Features

Emoji
You can use emoji by wrapping the emoji's name in colons. For example, :+1:. You can start typing : in any Markdown field to see a filterable list. There's even some special ReadMe emoji, like :owlbert:

:owlbert+:

!

Font Awesome

Font Awesome icons can also be used by typing :fa-iconname: (such as :fa-thumbs-up: for ) find all the icon names in this Font Awesome Cheatsheet.

Limited Icons

We use Font Awesome version 4.3, newer icons are not supported

Links
ReadMe uses a special format for linking to pages within ReadMe. You can type "[" to bring up the list of pages, and then type to filter that list.

Headers

We changed all header types (#,##) to their own h1/h2/h3 settings. This might have changed a CSS setting that you already had. Here's what the defaults look like now:

Did this answer your question?