ReadMe Documentation

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

Hub 2 Upgrade FAQ

What's new in Hub 2.0?

A lot! Here's a short list of some of the changes:

  • Much faster page loads, and everything is loaded via Ajax.
  • Improved UI.
  • Better search (fuzzy search for typos and much faster overall).
  • Allow your users to log in to your docs.
  • API Reference documentation and regular guides are split into two sections.
  • Huge improvements to the changelog, support forums, and others.
  • New features such as API Access, Health Check, Glossary and more.
  • All new future features will be added to Hub 2 only (aside from security features).

Frequently Asked Questions

How do I upgrade?

Please contact support to upgrade at this time.

What is the secondary navigation bar?
The secondary navigation bar contains links to ReadMe features and the version picker. It is required to utilize search and suggested edits. If you disable a feature, it will be removed from the bar.

What is the reference section?
API documentation pages are now moved into their own section, called Reference Guides. It is separate from your main docs and acts as a separate entity. Main docs will utilize the two-column layout and Reference Guides will be on the three-column layout going forward.

Where did Typekit go?
You just need the Typekit ID! Enter it in the third-party integrations section, then you can use the font in the custom CSS section as shown here.

Why is my JavaScript not working?
Pages are now loaded with Ajax, and jQuery v1.11.1 is included on the page. Your JavaScript will be included at the bottom of the page. To run JavaScript on each page load, use the pageLoad event.

$(window).on('pageLoad', function(e, state){
  // Your Code Here
});

Why is the login page separate?
The login page is now separate for security reasons. After migrating, you'll be able utilize your own Custom Login mechanism and even personalize their experience with your docs!

Other details:

  • Proxy can now be turned off for API requests, but you must allow ReadMe in your cross-origin resource sharing options.
  • Version picker and table of contents can be removed from the secondary navigation bar in the advanced settings of the appearance tab.
  • iFrames must be turned on in the advanced options of the custom domain tab.

Did this page help you?