ReadMe Documentation

Welcome to the ReadMe Documentation, where you'll find comprehensive guides and community support to help you start working with ReadMe as quickly as possible!

Get Started

ReadMe's Markdown

Markdown Overview

Almost every field on ReadMe supports GitHub Flavored Markdown.

You can learn about Markdown here:

You can learn about GitHub Flavored Markdown here:

Special ReadMe Features

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. Or, view the whole list here. There's even some special ReadMe emoji, like :owlbert: :owlbert+:!

Font Awesome
Any Font Awesome icons can be used by typing :fa-iconname: (such as :fa-thumbs-up: for )

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.


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:

ReadMe's Markdown