Discussions

Ask a Question
ANSWERED

How do I insert callouts into tables?

Hello everyone, checking to see if anyone knows how to insert callouts into tables, haven't been able to crack this just yet. Thank you!
ANSWERED

Custom Login apiKey Cutoff problem

https://docs.readme.com/docs/custom-login-with-readme Hi readme team. We use Auth0 behind the scenes for login and when we send the apiKey (4731 characters long) it gets cutoff in the readme API explorer. Is there a solution for this problem?
ANSWERED

Export and import Recipes

Is it possible to export existing recipes and import them?
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

Automated deployment of additional information for OpenAPI schema

Hi, I have the problem that I want to deploy a lot of OpenAPI schemas to readme. However these are not just standard schemas, but I would like to add custom annotations in html or markdown to each of the routes. This works nicely if I do it manually, but I need to do this in an automated way and I did not find a way to do it. Is there already an API to do so? If not it would be awesome to add it! Maybe the nicest way to do it would be to accept an extension field in the API spec JSON which can contain html and another for markdown.
ANSWERED

Dark mode support

We were thinking to migrate to Readme and because our previous system has dark mode support, we were thinking if this is planned. Developers staring at night on a bright documentation is something very unpleasant.
ANSWERED
ANSWERED

How to find Category ObjectId?

I want to update my documentation from local files. I'm using `npx rdme docs`, as specified in this recipe: https://docs.readme.com/recipes/sync-directory-of-files-via-cli However, it errors if I don't have the ObjectId of a pre-existing category for my project. I created a category in the readme UI but can't find the ObjectId anywhere on the UI. Where do I find the category ObjectId? Alternatively, how can I create a category using the API?
ANSWERED

Any support for estimated read time / # of words style macro?

This is a nice feature I've seen on other sites "Estimated read time: X minutes" which is usually based off the number of words, and the adult average read time of 300 words per minute. Does readme support this? How can I get this type of feature added to my pages on a business plan account?
ANSWERED

Community Discussion - External links open in the same browser tab

Hi, there I notice that within _this_ Community (at readme.com), external links open in the same browser tab. Example: https://www.oauth.com/oauth2-servers/making-authenticated-requests/refreshing-an-access-token/ Previously - if I am not mistaken - external links would open in a new tab. That seems to make more sense. Cheers