Discussions

Ask a Question
ANSWERED

Integration to other systems

Hello, friends! I am a developer from Superwise.ai team. We are using readme for our documentations and I have a question: Is it possible to integrate Recipe into our site as widget, iframe or something else? We want to show Recipe modal on our side without redirecting to all documentation. I didn't find anything in "readme" documentation about it and I've tried to add all page as iframe but received error about "X-Iframe_options" is set to "deny".
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?
ANSWERED

API Setup before markdow texts

When creating an API endpoint, I would like to start with the API setup and body params. After that, I would like to include complementary information, for example, a table with the response body params, table of errors or other aditional info. But... When I publish the page, all this markdown info goes to the top, and the API setup and boby params goes to the end of the page. How can we change this order?
ANSWERED

Can we add tags to documents so that they get surfaced in search better?

How can we tag documents so we can leverage the search API to get only docs that have that tag? Is this possible?
ANSWERED

Support pages directly from OpenAPI spec

Many APIs use `info.description` field to describe the API context (such as introduction and getting started), but currently according to the [OpenAPI Compatibility Chart](🔗) it currently does nothing. It will be very nice if pages could be created automatically using this field. Is there a way to do that without having to write those pages manually?
ANSWERED

Get OAS of specific version of API specification?

Hello, It says [here](https://docs.readme.com/reference/intro-to-the-readme-api#api-specification) that the "API Specification" endpoints can be used "to get, post, update, or delete the API specification that generates your API docs." But the only GET request I see for that endpoint is for the specification metadata. Am I missing something, or is it not currently possible to GET the OAS of a particular version of one's API spec from ReadMe via the API? Like, the JSON that got uploaded when creating a new version. Thank you. Zeke (Capable Health)
ANSWERED

Invalid request for multiple uploads

We have specification for attachments upload api. It allows to upload multiple files. Open API spec is here: <https://github.com/qase-tms/specs/blob/master/paths/attachment.code.yaml#L2> Readme page is here: <https://developers.qase.io/reference/upload-attachment> If client tries to check API in readme docs, readme generates invalid query. Readme tryes to upload files as base64 encoded payload. If we use openapi-generator, we get correct autogenerated code. So we suggest, that our specification is correct. Can you help to make readme docs work correctly?
ANSWERED

Control code block size

Is there any way to control the size of a code block and force it to wrap the code with in it? I have a JSON code example that's making the code block too wide for my page.
ANSWERED

Landing page: HTML/JS support and preview

Hello, I got two simple questions, for which I didn't find the answer in docs nor here: 1. Is it possible to use JS in HTML code for landing page content without resorting to custom HTML/CSS available in enterprise plans only? 2. Is there any preview functionality for a landing page or do I have to test changes directly on production?
ANSWERED

Creating Guides Search on External Website

Hi, We have been attempting to create a search via JS/Vue that hooks into the API to allow users to search a guide and then link to the particular guide on readme.io. We have attempted to use the search API: <https://docs.readme.com/docs/search-api>. Using our details we can generate results here: <https://docs.readme.com/reference/searchdocs> but when accessing via our external site we run into a CORS issue. A No 'Access-Control-Allow-Origin' header is present. Is there a way around this? Thx Matt