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

Intro 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
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
Technical FAQ
API Reference Redesign Overview (Q4 2021)
- Migration Guide Best Practices

Integrations

Set up integrations in your ReadMe project under Configuration > Integrations

Updated 8 months ago

What's Next

Slack
Google Analytics
Zendesk
Localize
Transifex
Typekit
Google Site Verification
Searching Readme in the Intercom Widget
reCaptcha