Discussions
Different alt text with the image widget?
The image widget uses the same text for the caption of a figure and for the alt text of the image. However, you might want different text, because these items have different audiences. You might use a brief description for the caption and a more detailed description for the alt text.
I know I can specify alt text via "plain" markdown:
```
```
But then I lose the benefits of the image widget.
Is there any way to do it?
Posted by Janet Swisher about 2 years ago
We only want to show the OAuth2 section in the Header and not show the apikey
We have 2 types under the SecuritySchemes node. One of them is oauth2 while the other one is apikey. Is there a way to make the apikey not visible in the API Reference page
Posted by Aziz about 2 years ago
Is there a way to expand or hide content?
In my organization's API guides, we sometimes need to list a lot (like, 30) API endpoints, which all are related to a specific functionality. Including such a list to a table or in the document body has a real negative impact on readability.
In our internal wiki (Confluence), I can create a table with an expand macro, so the user can toggle between viewing and hiding the list of endpoints.
Do you have any suggestions on how to work around this in ReadMe?
Posted by Katri Metsävuo about 2 years ago
what happens to my API documentation aftef my plan expires,does it get deleted or just gets invisible until i renew
Posted by Duru Chidozie about 2 years ago
Search box
Hello there,
Is it possible to use search box as a custom html code? I don't want to use it as a button, I want to embed it to the page and if there is a way, I'll be happy
Posted by Tosun about 2 years ago
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?
Posted by Ismaen Aboubakare about 2 years ago
How to Embed readme
Hi
Please do let me know that how can I use API of Readme in my website [Edenderma](https://www.edenderma.com)? I am trying to embed with plugin and also manually embed API references in the header or footer of my website but it's not working.
If you have any idea please do let me know.
Thank You
Posted by [email protected] about 2 years ago
Working OpenAPI spec parser/linter?
What tools are people using to validate their OpenAPI specs before uploading?
I have a spec that's considered valid by two separate tools but is being rejected when I upload to Readme.
The error is useless: "Unknown error (Cannot read property 'slug' of null)."
Ideally there is a tool out there which matches ReadMe's quirks so I can develop my APIs locally and know that when I push the code I will also be able to push the API updates.
Posted by Donncha about 2 years ago
Integration procedure of readme
Hi all
Hope you are doing good.
I want to ask that can I embed readme with my website [fast labour hire](https://fastlabourhire.com.au/)? I just want to embed API references in the header of my website. If is possible then how can I do it?
Posted by maxmarrie about 2 years ago
How to add open form in my Website
Hi
I just want to add a open form on my skincare website, so that I can track record of chat of customers through this
So please do let me know that how can it be possible?
Thank You
Posted by [email protected] about 2 years ago