Product Guide

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

Custom JavaScript and CSS

In this section you can add custom JS and CSS to further edit the appearance of your docs site.

Custom Stylesheet


You should limit your changes to minor tweaks. Additionally, stylesheets aren't versioned; all versions use the same stylesheet.

Custom JavaScript

Your JavaScript will be included at the bottom of the page.

Custom Include Tags

Header HTML

Any html here will be included in the head tag, which is good for things like meta tags and loading external CSS/JS.

Footer HTML
This will go right before the tag. Good for things like analytics and tracking.

Turning Off Custom JavaScript and CSS

You can add these query params to the end of any URL:

Updated about a month ago

Custom JavaScript and CSS

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.