These docs are for v2.0. Click to read the latest docs for v3.0.

Discussions

Ask a Question
ANSWERED

API reference of an TypeScript library

What's the recommended way of documenting a TypeScript library in readme?

ANSWERED

Can Recipes be programmatically added?

If I wanted to add a recipe programmatically, is there a way to do that?

ANSWERED

Pass JWT/API Key in request body via POST for Custom Login

In the https://docs.readme.com/main/docs/custom-login-page example, we're shown an example of passing the JWT through the URL when redirecting back to a project's docs page. Is there support for passing this data through a POST request body? Or any other ways outside of including the token in the URL params?

Replace example.com in api sync

Similarly to this issue, I am using an autogenerated openapi file from FastAPI, and don't see why there isn't an easy way to manually set the api endpoint for the generated docs, or at least sync with whatever endpoint the openapi file is retrieved from. This feature is blocking us from using the built-in request flow, a pretty big issue for our users. Is there any fix coming or available?

ANSWERED

Code block within a table

Is it possible to add a code block within a table?

ANSWERED

Unusual rendering of enum values in Response objects

I've noticed that enums render a little funny in the response schemas generated for the API Reference.

ANSWERED
ANSWERED

Adding line breaks to markdown tables synced via RDME tool

Hi,

ANSWERED

How to "Add Markdown Content" to OpenAPI content?

Hello,

ANSWERED

Disable click on image

Hiya! Clicking on an image in the Guide opens the image in a popout window. This is helpful if it's a small screenshot, but kinda useless if it's just an icon. Is there any way to turn of click-to-open on images, so the user can't click an image that shouldn't be clicked?
Thanx!