Discussions

Ask a Question
ANSWERED

Is it possible to paginate through a list of all docs?

I am working on a search index outside of ReadMe that searches multiple sources: my main marketing site, external blog site, etc. I would like to include my ReadMe docs in the search results. Is there an API method or some other way I can query for the full list of Docs?

ANSWERED

Moving a page to a newer version

Hi. Novice user here. I created a new page in a live version of our guide and then made that new page live, not realizing that another editor had already branched a new draft version. Several days later that draft was published, thus removing my new page from our live site. My question is how do I move that page to the new version? I can see that dragging and dropping the page within the old version is easy, but I can't seem to drag it into the new version and republish it live. Do I have to recreate the page in its entirely or is there a way to drag or clone it to the currently live version? Thank you,.

ANSWERED

Is it possible to vendor an offline version of docs?

Our application links out to our readme.com documentation, and we'd like to be able to serve the docs locally in case there is no active internet connection. Is this possible with readme?

ANSWERED

How to merge "manual" edits with OpenAPI docs generated from source code?

My team currently updates API docs manually via the readme UI, but we're exploring auto-generating the docs from the code of our rails app, and updating them via the readme API. We're stuck on what the correct pattern would be to resolve potential conflicts between manual edits directly in readme, and whatever new edits are generated from code and synced up via OpenAPI.

ANSWERED
ANSWERED

Let customers download open api spec

The admin dashboard has a way to export the api to oas spec file

ANSWERED
ANSWERED

How to edit the subnavigation bar?

It looks like I'm able to control the aspects of my projects on the landing pages. How do I control aspects on other pages? I am looking to edit the search functionality that appears in the top right of my docs pages.

ANSWERED

Protected Documentation

Can I change the way the page looks for when we ask the user for a password for protected documentation?

ANSWERED

Implementing Custom Search

I am looking to implement my own custom search. I know by default, ReadMe uses Algolia. I have indexed docs content in my own Algolia instance, and I want to make my own custom search experience. How would I go about customizing the search feature in ReadMe?