ReadMe Documentation

ReadMe Blog
We're Hiring!

{{user.name}}Log In

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

v2.0

v1.0-legacydeprecated
(Hub 1)
v2.0stable
(Hub 2)

Community Discussions

HomeProduct GuideRecipesAPI ReferenceReferenceChangelogCommunity DiscussionsPage Not FoundSearch{{ state.current().meta.title }}API Logs

Community Discussions

discard

Getting Started

Introduction
Best Practices
Features
Hub 2 Upgrade FAQ
Contact Support

Platform Usage

Dashboard
Search
- Search API
Preview Project

Interactive Docs

Log Your Users in with a Custom Login Flow
User Data in ReadMe

General Settings

Project Settings
Manage Team
- Transfer Ownership
- Add or Remove Admins
Upgrade Plan
Setting Custom Domain & SSL
Third-Party Integrations
Language Support/Localization
Error Pages
Redirect Scenarios
Protected Documentation
Health Check
Glossary

Appearance

Landing Page
Theme Editor
Site Navigation
Enable/Disable Sections
Site Footer
Reference Styling
Custom JavaScript and CSS

Documentation

ReadMe Flavored Markdown
Manage Pages
OpenAPI
Manual API Settings
- API Setup
- Raw body content
Recipes
Versions
Changelog
Custom Pages
Suggested Edits

Discussions

Submit a Question
Support Forum for Admins
FAQ

Other

Feature Requests
Reference FAQs
Miscellaneous Questions
Bug Bounty Program

Enterprise

Enterprise Features
Enterprise Dashboard
Enterprise Settings
Staging Environment
Upgrading to a Group Project
Adding and Removing Child Projects
Creating a Global Landing Page
Custom OAuth Login
- Setting up GitHub OAuth 2.0
Setting Up Single Sign-On (SSO)
Setting Up Access Control
User Roles
Audit Logs
PDF Generation
Metrics API Access
Enterprise FAQ

SEO

Meta Tags for SEO

API Metrics

API Metrics in ReadMe
- The API Metrics Dashboard
- Showing Logs in the Docs
Getting Started With API Metrics

Documentation Metrics

Documentation Metrics
Page Quality
User Analytics
Leads

Getting Started

Introduction
Best Practices
Features
Hub 2 Upgrade FAQ
Contact Support

Platform Usage

Dashboard
Search
- Search API
Preview Project

Interactive Docs

Log Your Users in with a Custom Login Flow
User Data in ReadMe

General Settings

Project Settings
Manage Team
- Transfer Ownership
- Add or Remove Admins
Upgrade Plan
Setting Custom Domain & SSL
Third-Party Integrations
Language Support/Localization
Error Pages
Redirect Scenarios
Protected Documentation
Health Check
Glossary

Appearance

Landing Page
Theme Editor
Site Navigation
Enable/Disable Sections
Site Footer
Reference Styling
Custom JavaScript and CSS

Documentation

ReadMe Flavored Markdown
Manage Pages
OpenAPI
Manual API Settings
- API Setup
- Raw body content
Recipes
Versions
Changelog
Custom Pages
Suggested Edits

Discussions

Submit a Question
Support Forum for Admins
FAQ

Other

Feature Requests
Reference FAQs
Miscellaneous Questions
Bug Bounty Program

Enterprise

Enterprise Features
Enterprise Dashboard
Enterprise Settings
Staging Environment
Upgrading to a Group Project
Adding and Removing Child Projects
Creating a Global Landing Page
Custom OAuth Login
- Setting up GitHub OAuth 2.0
Setting Up Single Sign-On (SSO)
Setting Up Access Control
User Roles
Audit Logs
PDF Generation
Metrics API Access
Enterprise FAQ

SEO

Meta Tags for SEO

API Metrics

API Metrics in ReadMe
- The API Metrics Dashboard
- Showing Logs in the Docs
Getting Started With API Metrics

Documentation Metrics

Documentation Metrics
Page Quality
User Analytics
Leads

API Endpoints

Intro to the ReadMe API
Authentication
rdme command-line client
Limiting API results
API Specification
Apply to ReadMe
- post
  Submit your application!
Categories
Changelog
Custom Pages
Docs
Errors
- get
  Get errors
Projects
- get
  Get metadata about the current project
Version

Developer Metrics API

Metrics API Introduction
API Explorer
Companies
- get
  Get list of companies that have viewed docs
- get
  Get all data on company for docs project
Page Views
API Logs
Search
- get
  Get most searched terms for docs project
- get
  Get metrics for specific search term
Thumb Vote

Powered by

We’re currently having some issues with our infrastructure. Please check back soon to see if this has been resolved. Learn more