ReadMe

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

Error Pages

Found under Documentation > Configure > Error Pages

404 Page

We show our generic 404 page by default when a customer tries to access a broken link

Our generic 404 page

Our generic 404 page

Use a Custom Page as your 404 message instead for a look that better represents your brand.

Redirects

You can also set up 301 redirects if there is no matching ReadMe page. We'll check it to see if there's a redirect rule for the URL. You can use this to redirect your old non-ReadMe paths to your new site when migrating to ReadMe. Use the format "oldurl -> newurl" (for example, "/documentation/test -> /docs/test"), with one per line.

Here's some examples:

/docs/top-feature-requests -> /docs/feature-requests
/docs/getting-started -> /docs/get-started
/docs/ios-sdk -> http://github.com/company/ios-sdk

/google -> http://google.com
/old/([a-z]*) -> /new/$1
* -> /custom-error-page

Cannot redirect from Reference section

It is not possible to redirect from a hashed URL like https://readme.readme.io/v2.0/reference#api-specification but it is possible to redirect to a hashed URL

Regular Expressions

You can use regular expressions! It uses JavaScript-style regexes, and must be a full match. To use a captured value on the redirect, use $1 (or 2, 3, etc).

If you want a catch-all, use *.

Troubleshooting

  • Browsers cache these redirects, so changes might not work immediately
  • Regexes must be a complete match, not a partial match. You can't use ^ or $, because they're appended automatically
  • Redirects are tested in order they're written, and the first match is used
  • Redirects are for 404 pages only, if the page exists, it will not redirect

White Label Plan

This feature is only available for the White Label plan


Error Pages


Suggested Edits are limited on API Reference Pages

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