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

Enable/Disable Sections

ReadMe has six components in the Project Dashboard:

  1. Landing Page
  2. Documentation
  3. Reference Guides
  4. Changelog
  5. Custom Pages
  6. Discussions

To enable/disable these sections, navigate to Documentation. Hover over each component to enable or disable it.

Disabling the feature will remove all content within that feature from the public and remove it from the navigation bar.


Custom Pages cannot be disabled. As long as you don't have any Custom Pages, they will not appear anywhere so there is nothing to disable!

Enable/Disable Sections

Suggested Edits are limited on API Reference Pages

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