Integrations

Jump to Content

Customer Stories ReadMe Blog

Guides Recipes API Reference Changelog Discussions

Customer Stories ReadMe Blog Log In

Guides Recipes API Reference Changelog Discussions

🏁 QUICK START

Welcome to ReadMe!
Best Practices
Use Cases Overview
Features Overview
Navigating Your Hub
- Search + Search API
- Quick Nav in the API Reference

⚙️ PROJECT SETUP

Project Setup Overview
Adding Your API Reference
OpenAPI Support in ReadMe
Sending API Logs
Personalizing Your Docs
API Reference: Getting Started & Authentication
Setting Custom Domain & SSL
How to Launch Your Project

📝 DOCUMENTATION

Writing & Managing Docs
Structuring Your Docs
New Markdown Editor Overview
New Sidebar & Page Controls Experience
Maintaining Your Docs
Syncing Docs via CLI / GitHub
- GitHub Actions Example: Syncing Markdown
- GitHub Actions Example: Syncing OpenAPI

📊 USING METRICS

Metrics Overview
- Using Metrics Charts
- Metrics Pricing FAQ
Track API Usage
Troubleshoot API Issues
Insights to Improve Your Hub

👋 DEVELOPER COMMUNITY

Supporting Your Developers
Discussion Forums
- Managing Forum Support
- Creating a Dev FAQ
Health Check Status Updates

🎨. PROJECT CUSTOMIZATION

Making Your Hub Shine
Design Themes
Custom CSS and JavaScript
- Customizing Docs Using CSS Variables
Dark Mode: Overview & Custom CSS
Site Navigation
- Subheader Layout
- Site Footer
Pro Tips
Integrations

🔑 ACCOUNT & SETTINGS

Your Account
Two-Factor Authentication
Manage Team
- Transfer Ownership
- Add or Remove Admins
Plans and Pricing
- Upgrades and Payment Info
- Billing FAQ

❓ TECHNICAL SUPPORT & QUESTIONS

Need More Support?
Feature Requests
Security FAQ
- Bug Bounty Program
Technical FAQ
API Reference Redesign Overview (Q4 2021)
- Migration Guide Best Practices

Set up integrations in your ReadMe project under **Configuration > Integrations**

Label

URL

Iframe URL

Delete

Maximum File Size is 30 MB

Alt Text

Delete

Delete

Languages

Remove Tab

Link

Heading 1

Heading 2

Heading 3

Blockquote

Callout - Success

Callout - Info

Callout - Warning

Callout - Error

Bulleted List

Numbered List

Check List

Code

Divider

Image

Recipe

Table

Embeds

YouTube

GitHub Gist

PDF

JSFiddle

Iframe

Advanced

Custom HTML

apiKey

Variable

user

Variable

ReadMe

Variable

id

Variable

email

Variable

Enterprise group

Glossary Term

Enterprise group Owner

Glossary Term

Enterprise group Admin

Glossary Term

Project Admin

Glossary Term

Project Owner

Glossary Term

Teammates

Glossary Term

Viewer

Glossary Term

End Users

Glossary Term

Some Projects

Glossary Term

dashboard

Glossary Term

hub

Glossary Term

variables

Glossary Term

Page

Glossary Term

Subpage

Glossary Term

Changelog

Glossary Term

Discussions

Glossary Term

Documentation

Glossary Term

Reference

Glossary Term

Slug

Glossary Term

Glossary

Glossary Term

pop up

Glossary Term

internal

Glossary Term

external

Glossary Term

login mechanisms

Glossary Term

RDMD

Glossary Term

API Explorer

Glossary Term

API Reference

Glossary Term

dereferenced

Glossary Term

Enterprise Group

Glossary Term

Enterprise Group Owner

Glossary Term

Enterprise Group Admin

Glossary Term

Project Admin

Glossary Term

Project Owner

Glossary Term

Viewer

Glossary Term

dash

Glossary Term

variables

Glossary Term

dashboard

Glossary Term

hype train

Glossary Term

Custom

Glossary Term

Teammates

Glossary Term

End Users

Glossary Term

hub

Glossary Term

-1

+1

100

1234

8ball

a

ab

abc

abcd

accept

aerial-tramway

airplane

alarm-clock

alien

ambulance

anchor

angel

anger

angry

anguished

ant

apple

aquarius

aries

arrow-backward