# ReadMe Documentation > Beautiful documentation made easy. Fetch the complete documentation index at: https://docs.readme.com/main/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version. ## Guides: Getting Started - [Getting Started index](https://docs.readme.com/main/docs/getting-started/llms.txt): full category index - [Welcome to ReadMe](https://docs.readme.com/main/docs/about-readme.md): Helping you create docs that make your APIs easy to use and maintain. - [Quickstart](https://docs.readme.com/main/docs/quickstart.md): Get your API documentation live in three steps: create a project, upload your API definition, and write your first guide. - [Build with AI](https://docs.readme.com/main/docs/ai-overview.md): AI tools for writing, reviewing, and consuming documentation. - [Migrating to ReadMe](https://docs.readme.com/main/docs/migration-moving-your-docs-to-their-new-home.md): This guide helps you bring your existing docs into ReadMe through a few options, depending on your needs. ## Guides: AI - [AI index](https://docs.readme.com/main/docs/ai/llms.txt): full category index - [Agent](https://docs.readme.com/main/docs/aiagent.md): Draft, edit, and research documentation from the AI chat panel. - [The Agent in the Editor](https://docs.readme.com/main/docs/inline-ai.md): Make edits with AI to rewrite, shorten, expand, or improve selected text - [Linter](https://docs.readme.com/main/docs/linter.md): An AI-powered tool for checking page content against your own style guide. - [Docs Audit](https://docs.readme.com/main/docs/docs-audit.md): Score your entire documentation against your style guide in one run. - [GitHub AI Writer](https://docs.readme.com/main/docs/github-ai-writer.md): Proposes documentation updates when pull requests change your codebase. - [Ask AI](https://docs.readme.com/main/docs/ask-ai.md): An AI assistant embedded in your docs that answers your users' questions. - [MCP](https://docs.readme.com/main/docs/mcp.md): Give your users' AI tools live access to your API spec and docs. - [MCP Metrics](https://docs.readme.com/main/docs/mcp-metrics.md): See which tools AI agents call on your MCP server, how fast those calls return, and what they asked for. - [Discoverability](https://docs.readme.com/main/docs/ai-discoverability.md): Make your documentation discoverable and accessible to AI agents and the assistants your readers bring with them. ## Guides: Project Setup - [Project Setup index](https://docs.readme.com/main/docs/project-setup/llms.txt): full category index - [Creating a Project](https://docs.readme.com/main/docs/creating-a-project.md): Learn how to create your first ReadMe project, navigate the dashboard, manage your profile, and organize your API documentation effectively. - [Your Dashboard and Profile](https://docs.readme.com/main/docs/your-dashboard-and-profile.md): Update your profile, configure projects, manage API keys, and add a custom domain from your ReadMe dashboard. - [Navigate Your Docs](https://docs.readme.com/main/docs/navigating-your-hub-1.md): Find your way around the redesigned admin interface and editor - [Custom Domain & SSL](https://docs.readme.com/main/docs/setting-up-custom-domain.md): Host your docs on your own domain, covering CNAME setup, apex domains versus subdomains, and SSL certificates. - [Having Problems Generating SSL?](https://docs.readme.com/main/docs/having-problems-generating-ssl.md): Diagnose a custom domain that will not issue an SSL certificate, including how to check your CNAME record with dig. - [URL Paths in ReadMe](https://docs.readme.com/main/docs/url-paths-in-readme.md): Work out how ReadMe builds your documentation URLs, for both single projects and Enterprise groups. - [Turn Off Cloudflare Proxy](https://docs.readme.com/main/docs/turn-off-cloudflare-proxy.md): For customers that use Cloudflare - [Using a Reverse Proxy](https://docs.readme.com/main/docs/using-a-reverse-proxy.md): What to weigh before putting your own proxy or CDN in front of ReadMe, and what the proxy has to do if you go ahead. - [System Configuration](https://docs.readme.com/main/docs/system-configuration.md): Configure the backend settings that keep your hub running and secure. - [Login Expiration](https://docs.readme.com/main/docs/login-expiration.md): Set how long a reader stays signed in to your docs before they have to log in again, under Custom Login settings. - [Internal Documentation](https://docs.readme.com/main/docs/internal-documentation.md): Control who can access your docs - [Error Pages and Redirects](https://docs.readme.com/main/docs/error-pages.md): Choose what endusers see when they encounter a 404 in your project - [Redirect Scenarios](https://docs.readme.com/main/docs/redirect-scenarios.md): Learn how and when visitors to your project are redirected to other pages - [Outbound IP Addresses](https://docs.readme.com/main/docs/ip-addresses.md): Allowlist the outbound IP addresses ReadMe sends API requests from, so Try It! and API Metrics reach your API. - [OpenAPI Support](https://docs.readme.com/main/docs/openapi.md): Check which OpenAPI versions and file types ReadMe accepts, and what your definition gives your API Reference. - [Categories, Pages, and Subpages](https://docs.readme.com/main/docs/openapi-categories-pages-subpages.md): See how ReadMe turns an OpenAPI document into categories, pages, and subpages, and what changes when operations carry tags. - [Re-syncing Your OpenAPI Document](https://docs.readme.com/main/docs/openapi-resyncing.md): Update an API Reference after your definition changes, covering API definition IDs, tag changes, and operation IDs. - [OpenAPI Compatibility Chart](https://docs.readme.com/main/docs/openapi-compatibility-chart.md): Look up which parts of the OpenAPI Specification the API Explorer supports, field by field, including known quirks. - [OpenAPI Extensions](https://docs.readme.com/main/docs/openapi-extensions.md): We've added a few OpenAPI extensions to help you better integrate with ReadMe. - [Custom Login Page](https://docs.readme.com/main/docs/custom-login-page.md): Log developers into your docs with JWT so each one sees their own API keys and personalized content in the API Reference. - [Custom Data in Your Docs](https://docs.readme.com/main/docs/user-data-options.md): Pass JSON about a signed-in developer to ReadMe and use it as variables in your docs, API Reference, and Try It! requests. - [Integrations](https://docs.readme.com/main/docs/integrations.md): Connect third-party services to your ReadMe project from Configuration > Integrations. - [Amazon API Gateway](https://docs.readme.com/main/docs/aws.md): Connect ReadMe to Amazon API Gateway. This integration is not yet available in the Refactored experience. - [Google Analytics](https://docs.readme.com/main/docs/google-analytics.md): Add your own Google Analytics to your hub, using either a Universal Analytics or Google Analytics 4 property ID. - [Google Site Verification](https://docs.readme.com/main/docs/google-site-verification.md): Verify ownership of your hub with Google by pasting your meta tag string into Integrations settings. - [Searching ReadMe in the Intercom Messenger](https://docs.readme.com/main/docs/searching-readme-within-the-intercom-widget-changing-so-404-results-rb.md): Let your users search your ReadMe docs directly from the Intercom Messenger widget. - [Postman](https://docs.readme.com/main/docs/postman-1.md): Keep your documentation updated alongside your Postman collections. - [Localize](https://docs.readme.com/main/docs/localize.md): Connect Localize to your hub to manage translations in their platform, including the reader-facing language picker. - [reCaptcha](https://docs.readme.com/main/docs/recaptcha.md): Add Google reCaptcha to your discussion forums so new posts and comments are checked before they publish. - [Segment](https://docs.readme.com/main/docs/segment.md): Send page view data from your hub to Segment, including how to proxy requests through your own custom domain. - [Slack](https://docs.readme.com/main/docs/slack.md): Get updates on your docs directly within Slack! - [Transifex](https://docs.readme.com/main/docs/transifex.md): Connect Transifex to your hub to manage translations in their platform. - [Typekit](https://docs.readme.com/main/docs/typekit-key.md): Add your Typekit key so you can use Adobe fonts in your hub's custom CSS. - [Zendesk](https://docs.readme.com/main/docs/zendesk.md): Add the Zendesk support widget to your hub so readers can open a ticket without leaving your docs. ## Guides: Writing Docs - [Writing Docs index](https://docs.readme.com/main/docs/writing-docs/llms.txt): full category index - [Guides](https://docs.readme.com/main/docs/guides.md): Write long-form tutorials, walkthroughs, and explanations that sit beside your API Reference, in Markdown with MDX support. - [Creating and Managing Guides](https://docs.readme.com/main/docs/creating-and-managing-guides.md): Create, structure, and maintain guide pages in ReadMe, from your first page through categories, MDX, reusable content, and Git review. - [Structuring Your Documentation](https://docs.readme.com/main/docs/structuring-your-docs.md): Plan a documentation architecture developers can navigate, from choosing a structure through cross-linking and scaling it. - [Creating Mermaid Diagrams](https://docs.readme.com/main/docs/creating-mermaid-diagrams.md): Add flowcharts, sequence diagrams, and other Mermaid diagrams to your docs with a slash command, written as text rather than images. - [API Reference](https://docs.readme.com/main/docs/api-reference.md): Learn how to use your API Reference to transform your API into a clear and accessible solution for developers. - [OpenAPI Upload and Management](https://docs.readme.com/main/docs/openapi-upload-and-management.md): Learn how to upload and manage your OAS files. - [API Designer](https://docs.readme.com/main/docs/api-designer.md): Build an API Reference without an OpenAPI file, defining endpoints, parameters, and responses in the API Designer's visual editor. - [GraphQL API Reference (Limited Support)](https://docs.readme.com/main/docs/graphql.md): Try our GraphQL API Reference! - [OAuth Flows in Try It!](https://docs.readme.com/main/docs/oauth-workflows-in-try-it.md): OAuth flows automatically apply authentication headers to API requests based on your OpenAPI security schemes - [Recipes](https://docs.readme.com/main/docs/recipes.md): Step-by-step code walkthroughs for your most popular API use cases - [Creating a Recipe](https://docs.readme.com/main/docs/creating-recipes.md): Turn a code sample into a Recipe: a stepped, annotated walkthrough developers can follow one line at a time. - [Changelog](https://docs.readme.com/main/docs/changelog.md): Keep a running record of your latest updates - [Landing Page](https://docs.readme.com/main/docs/landing-page.md): Design the front door to your developer hub, including the header, the body, and the sections readers see first. - [Custom Pages](https://docs.readme.com/main/docs/custom-page.md): Build a page that keeps your hub's top navigation but replaces everything below it, for landing pages and other full-width layouts. - [MDX](https://docs.readme.com/main/docs/mdx.md): Write MDX in ReadMe, including the JSX syntax and the places where it behaves differently from plain Markdown. - [Built-in Components](https://docs.readme.com/main/docs/built-in-components.md): ReadMe provides several powerful MDX components out of the box. - [Custom Components](https://docs.readme.com/main/docs/building-custom-mdx-components.md): Write custom MDX components in JSX with a live preview, then reuse them across your docs or browse the component marketplace. - [Troubleshoot MDX Errors](https://docs.readme.com/main/docs/rendering-errors-invalid-mdx.md): Fix the MDX errors that appear after migration, covering unclosed tags, attributes, comments, variables, and invalid HTML. - [Reusable Content](https://docs.readme.com/main/docs/reusable-content.md): Create reusable blocks of Markdown content to use repeatedly across your project’s Guides and API reference pages! ## Guides: workflows - [workflows index](https://docs.readme.com/main/docs/workflows/llms.txt): full category index - [Integrate into Your Workflow](https://docs.readme.com/main/docs/integrate-your-workflow.md): Everything you need to integrate ReadMe into your deployment workflows - [Branching](https://docs.readme.com/main/docs/branching.md): Create and review documentation changes in isolation, so nothing reaches your live hub until your team has approved it. - [Docs-as-code](https://docs.readme.com/main/docs/docs-as-code.md): Run documentation entirely through Git, with Markdown and OpenAPI in your repository and pull requests as the review step. - [Hybrid](https://docs.readme.com/main/docs/hybrid.md): Manage API definitions in Git while your team writes docs in ReadMe, for organizations scaling across products and teams. - [Bi-Directional Sync](https://docs.readme.com/main/docs/bi-directional-sync.md): Connect your project to a GitHub, GitLab, or Bitbucket repository so content stays in step whether you edit in ReadMe or in your repo. - [Sync with GitHub](https://docs.readme.com/main/docs/sync-with-github.md): Connect your project to a GitHub repository for bi-directional sync, including the permissions you need and how to change repositories. - [Sync with GitLab ](https://docs.readme.com/main/docs/sync-with-gitlab.md): Connect your project to a GitLab repository for bi-directional sync, including how protected branches behave. - [Documentation Structure](https://docs.readme.com/main/docs/documentation-structure.md): Learn about how we've structured our documentation for two-way syncing - [Syncing Docs via CLI / GitHub](https://docs.readme.com/main/docs/rdme.md): Update your docs automatically with `rdme`, ReadMe's official CLI and GitHub Action! - [GitHub Actions Example: Syncing Markdown](https://docs.readme.com/main/docs/github-actions-docs-example.md): Copy a working GitHub Actions workflow that syncs your Markdown files to ReadMe with rdme on every push. - [GitHub Actions Example: Syncing OpenAPI](https://docs.readme.com/main/docs/github-actions-openapi-example.md): Copy a working GitHub Actions workflow that validates and uploads your OpenAPI definition to ReadMe with rdme. - [ReadMe's MCP Server](https://docs.readme.com/main/docs/readme-mcp.md): Search, read, and update your documentation from any AI coding assistant or CI pipeline. ## Guides: Version Control - [Version Control index](https://docs.readme.com/main/docs/version-control/llms.txt): full category index - [Versioning](https://docs.readme.com/main/docs/versions.md): Maintain more than one version of your docs, covering version settings, the reader-facing dropdown, and common use cases. - [Branches](https://docs.readme.com/main/docs/branches.md): Branches allow admins to save changes across pages without them going live immediately. - [Reviews](https://docs.readme.com/main/docs/reviews.md): Reviews allow you to check your changes for issues with the AI Linter or get approval from a teammate. - [Notifications](https://docs.readme.com/main/docs/notifications.md): Stay informed on branch review activity across your projects - [Tagging Reviewers](https://docs.readme.com/main/docs/tagging-reviewers.md): Make sure the right people see and review changes - [Suggest in GitHub](https://docs.readme.com/main/docs/suggest-in-github.md): Suggesting changes from GitHub allows anyone reading your documentation to provide direct feedback in context. ## Guides: Developer Experience - [Developer Experience index](https://docs.readme.com/main/docs/developer-experience/llms.txt): full category index - [Developer Dashboard](https://docs.readme.com/main/docs/developer-dashboard.md): Combine personalized, real-time API logs with API documentation. Plus surface your developers’ API keys right in your hub ✨ - [My Developers Overview](https://docs.readme.com/main/docs/my-developers.md): In-depth developer profiles where your team can dig into API usage and quickly debug issues - [Personalized API Docs Overview](https://docs.readme.com/main/docs/personalized-docs.md): Inject your users' API keys, server variables, and more! - [Set Up Personalized Docs](https://docs.readme.com/main/docs/personalized-docs-webhook.md): By telling ReadMe about the currently logged in user, the docs can show them their real API key, request history, and more! - [Using Amazon API Gateway with the Personalized Docs Webhook](https://docs.readme.com/main/docs/amazon-api-gateway-webhook.md): Set up the Personalized Docs Webhook when you provision API keys through Amazon API Gateway, so readers see their own keys in your docs. - [API Exploration Tools](https://docs.readme.com/main/docs/api-exploration-tools.md): Let developers call your API from inside your docs, so your reference becomes something they test rather than only read. - [Real-Time API Logs Overview](https://docs.readme.com/main/docs/sending-api-logs.md): Show developers their own API request history in your docs, and give your team visibility into how the API is being used. - [API Reference Landing Pages](https://docs.readme.com/main/docs/reference-core-pages.md): Give developers an on-ramp into your API Reference by surfacing their own API keys and server variables on its landing pages. - [My Requests Overview](https://docs.readme.com/main/docs/my-requests.md): Let your users see their recently made API requests and debug issues right from your docs - [Show API Request History To Users](https://docs.readme.com/main/docs/showing-api-logs-to-users.md): Surface a developer's real API request history inside your docs so they can debug their own calls. - [SDKs](https://docs.readme.com/main/docs/sdks.md): This section explains the prerequisites to consider when setting up a ReadMe SDK for the first time. - [Node.js Setup](https://docs.readme.com/main/docs/sending-logs-to-readme-with-nodejs.md): Send API logs from a Node.js or Express application to ReadMe Metrics, including security considerations. - [Python (Django) Setup](https://docs.readme.com/main/docs/python-django-api-metrics.md): Send API logs from a Django application to ReadMe Metrics, including how to identify the API caller. - [Python (Flask) Setup](https://docs.readme.com/main/docs/python-flask-api-metrics.md): Send API logs from a Flask application to ReadMe Metrics, including how to identify the API caller. - [PHP (Laravel) Setup](https://docs.readme.com/main/docs/sending-logs-to-readme-with-php-laravel.md): Send API logs from a Laravel application to ReadMe Metrics, including how to identify the API caller. - [Ruby (Rails/Rack) Setup](https://docs.readme.com/main/docs/ruby-api-metrics-set-up.md): Send API logs from a Rails or Rack application to ReadMe Metrics, including configuration options. - [.NET Setup](https://docs.readme.com/main/docs/net-setup.md): Send API logs from an ASP.NET Core application to ReadMe Metrics, including middleware setup and configuration options. - [Other Ways to Send API Requests](https://docs.readme.com/main/docs/other-ways-to-use-api-metrics.md): Send API logs to ReadMe when your language or API gateway does not yet have a Metrics SDK. - [API & Docs Metrics Charts](https://docs.readme.com/main/docs/using-metrics-charts.md): Dig into the details of how your developers are using your API and docs with Metrics charts - [Export Metrics Data](https://docs.readme.com/main/docs/exporting-metrics-data.md): Export your API and Documentation Metrics so you can analyze hub and endpoint usage in your own tools. - [Community Building](https://docs.readme.com/main/docs/community-building.md): Turn your hub into a place developers help each other, using discussion forums, a dev FAQ, and the support tools built into ReadMe. - [Discussion Forums](https://docs.readme.com/main/docs/discussion-forums.md): Let readers ask and answer questions in your hub, upvote the ones they share, and get replies from your team. - [Managing Forum Support](https://docs.readme.com/main/docs/managing-forum-support.md): Handle incoming forum questions, route notifications to email or Slack, and keep answered threads useful to the next reader. - [Creating a Dev FAQ](https://docs.readme.com/main/docs/creating-a-dev-faq.md): Build an FAQ from the questions your developers actually ask in the forum, and surface it in your hub's sidebar. - [Health Check Status Updates](https://docs.readme.com/main/docs/health-check-status-updates.md): Communicate real-time status to your users - [Supporting Your Developers](https://docs.readme.com/main/docs/supporting-your-developers.md): Make your hub feel built for the developer using it, from personalized API keys to interactive request history. ## Guides: Customizing Docs - [Customizing Docs index](https://docs.readme.com/main/docs/customizing-docs/llms.txt): full category index - [Themes](https://docs.readme.com/main/docs/design-themes.md): Set your hub's look from four theme presets, then tune brand colors and typography in Appearance settings. - [Custom CSS, HTML, and JavaScript](https://docs.readme.com/main/docs/custom-css-and-javascript.md): Apply your own CSS, JavaScript, and include tags to your hub, with the plan requirements and toggles for each. - [Custom Icons](https://docs.readme.com/main/docs/custom-icons.md): Use Font Awesome 7 Regular and Duotone icons in your docs, including how to hide a decorative icon from screen readers. - [Site Navigation](https://docs.readme.com/main/docs/site-navigation.md): Configure your hub's navigation, including where the logo links and how the top bar is arranged. - [Site Footer](https://docs.readme.com/main/docs/site-footer.md): Remove the ReadMe logo and add your own footer HTML. White labeling is available on Enterprise plans. ## Guides: ReadMe Refactored - [ReadMe Refactored index](https://docs.readme.com/main/docs/readme-refactored/llms.txt): full category index - [Upgrade Guide](https://docs.readme.com/main/docs/upgrade-to-readme-refactored.md): Upgrade your project to ReadMe Refactored, with what is new, how to do it yourself, and what Enterprise customers get. - [Upgrade FAQ](https://docs.readme.com/main/docs/upgrade-faq.md): See what changes when you upgrade to ReadMe Refactored, including the breaking changes to rdme and the API. ## Guides: Administration - [Administration index](https://docs.readme.com/main/docs/administration/llms.txt): full category index - [Settings](https://docs.readme.com/main/docs/project-settings.md): Access settings to manage and configure your docs. - [Your Account](https://docs.readme.com/main/docs/your-account.md): We're happy you're here! - [Two-Factor Authentication](https://docs.readme.com/main/docs/two-factor-authentication.md): Enable two-factor authentication on your ReadMe account, generate backup codes, and choose an authenticator app. - [Teammates and Roles](https://docs.readme.com/main/docs/manage-team.md): Control who can access admin controls and edit content. - [Plans and Pricing](https://docs.readme.com/main/docs/plans-and-pricing.md): We offer a variety of plans to suit your needs, whether you’re just getting started or looking for enterprise-grade solutions. - [Payment and Billing Info](https://docs.readme.com/main/docs/payment-and-billing-info.md): “I saw a bank that said ‘24 Hour Banking,’ but I didn’t have that much time.” - [Exporting Data](https://docs.readme.com/main/docs/exporting-data.md): Export your docs using our built-in features, tooling, and our API. ## Guides: Support - [Support index](https://docs.readme.com/main/docs/support/llms.txt): full category index - [Need More Support?](https://docs.readme.com/main/docs/need-more-support.md): Reach ReadMe support through the Intercom widget, see expected response times, and find the Slack community. - [Technical FAQ](https://docs.readme.com/main/docs/technical-faq.md): Find answers to technical questions about how your hub behaves, including how long pages cache for logged-out readers. - [Security](https://docs.readme.com/main/docs/security-faq.md): Find how ReadMe handles data access, data storage, and third-party integrations, with the answers customers ask for most. - [Allow iFrames](https://docs.readme.com/main/docs/allowing-iframes.md): Allow your hub to be embedded in an iframe from Custom Domain settings, and weigh the security tradeoff before you turn it on. - [Accessibility Report](https://docs.readme.com/main/docs/vpat.md): Read ReadMe's accessibility conformance against WCAG 2.1 AA, covering daily automated testing and manual audits. ## Guides: Migration Guides - [Migration Guides index](https://docs.readme.com/main/docs/migration-guides/llms.txt): full category index - [Migrate from Mintlify](https://docs.readme.com/main/docs/migrate-from-mintlify-to-readme.md): Move Mintlify docs to ReadMe and run Guides, API Reference, Changelog, and Recipes on one platform, with per-developer usage data in My Developers. - [Migrate from GitBook](https://docs.readme.com/main/docs/migrate-from-gitbook.md): Move GitBook docs to ReadMe and build fully custom MDX components beyond GitBook's block editor, with Guides and API Reference on one platform. - [Migrate from Fern](https://docs.readme.com/main/docs/migrate-from-fern.md): Move Fern docs to ReadMe and decide your SDK strategy on your own terms. Run Guides and API Reference on one platform, and see exactly what needs rebuilding. - [Migrate from Docusaurus](https://docs.readme.com/main/docs/migrate-from-docusaurus.md): Move Docusaurus docs to ReadMe without losing your Markdown or OpenAPI reference. See what transfers, what needs rebuilding, and the easiest path to get there. - [Migrate from another platform](https://docs.readme.com/main/docs/migrate-to-readme-other.md): Move documentation from Document360, Redocly, Scalar, Slate, a static site generator, or a custom platform to ReadMe with reusable content, Branches and Reviews, and an OpenAPI-generated API Reference. - [Developer Nuances](https://docs.readme.com/main/docs/migration-developer-nuances.md): Advanced guidance for migrating an OpenAPI definition: which third-party extensions carry over, how tags become navigation, and the rdme commands for splitting, resolving, and validating your spec.