Discussions

Ask a Question
ANSWERED

add summary o description over tag

im working with opeanpi 3.0.3 and i would like to add a custom description for root tag like a "payment link" see image ![](https://files.readme.io/a7a2dba-image.png) it is posible ?

When will ReadMe support AsyncAPI?

Our team (growing startup of ~30) wants to transition our full docs to <http://readme.io>, but we can't until you add AsyncAPI support. I've seen many other readme users ask for this feature as well - see other questions and other comments on multiple forums. This is a vital issue for us and a major pain point with ReadMe's current platform. Because you don't yet support AsyncAPI, we have to use bump.sh for our streaming API (<https://streaming.hume.ai/doc/streaming-api>), although we'd prefer to unify everything on ReadMe and have a single documentation site. **What will it take to convince your team to add AsyncAPI support to the product roadmap? When can we expect it to be added? ** If this isn't going to be a priority anytime in the near future, we may have to look into other docs products.
ANSWERED

Can you use a custom domain for API docs with free or startup plans?

Like the title says! I'm curious if you can use a custom domain when you aren't on the enterprise plan. Thanks!
ANSWERED

Custom javascript button

Is it possible to add a custom javascript button on the left or upper menu? I have a widget that I want to be executed when somebody clicks on the menu item.
ANSWERED

Potential bug with shared names between guid & api reference categories & pages.

Hi there, My name is Alexander, I'm a developer from FundApps. I am currently looking at using readme to consolidate our implementation and I noticed a couple of issues in playing around. If you create a category with the same name as an API reference that the admin window gets into a broken state where it becomes difficult to move pages and delete categories. Similarly if you duplicate page names between your api reference and your guide, the api reference page appears in the guide. Are these intended behaviours? It comes across to me like a potential issue if you are syncing documentation across 2 or more Github repositories (which don't have knowledge of the page titles between repositories). The first issue we can be careful about, but the second is harder to ensure safety. Otherwise I am super keen on using ReadMe and will be presenting to my company! Thanks, Alex
ANSWERED

New submenu item

Can we add a second page like API Reference to the subHeader?

Can I use custom variables from my Personalised-Docs to pre popuaate fields in my api-definitions ?

I have custom variables that are configured in personalised docs and I want to use these variables as default values( pre-poulate the fileds) in my api's.
ANSWERED

Dynamic Variable

Hi, We want to pass a dynamic variable for one of the Parameter in Post Request. The goal is to update/generate a UID in that parameter when users clicks on try it. We are unable to pass the dynamic value, please guide us how to pass the dynamic value in a parameter in readme
ANSWERED

Get doc returns no url

The get doc endpoint always returns an empty string as the link_url field. How can I get the url of the doc from the API?
ANSWERED

Attachments

Hi, I have a question about the attachements.]h To put it in the readme ir it necessary to creat a repository on github or can I upload it directly through the readme?