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

Discussions

Ask a Question
ANSWERED

Changing badges in API reference

Hi there,

ANSWERED

Link color in dark mode

Currently, I can change the link color in the "Appearance" settings. But it only affects the link colors in light mode. I don't see a way to change the link color in the dark mode.

Is there a workaround for supporting "anyOf" in readme?

I am working to port over our docs and we use anyOf for an object type. Does readme support that structure? if not is there a workaround?

How to provide the OpenAPI specification to the customers?

Hi, we want to share the OpenAPI specification publicly with our customers. We see that there is a public link for it("view oas"), but this link is not permanent across API versions. Could you please advise us on how to achieve what we want? The feature is much needed because some developers still prefer to import the file in Postman.

Customing Tags in OAS

Pages are created when we specify tags in our OAS, but I wanted to add more information on this page, ideally a markdown. Is there a way for us to do this via CLI?

Expanding search limitations

Are there any plans to expand the search limitations on Algolia searches? I want to use collapsible sections in my guides, but can't because of the way the search ignores content wrapped in raw HTML. I know you can assign keywords for SEO metadata, but do those keywords also come up in search results within my product guides? I'd love to not have to choose between lots of scrolling and ensuring searches return the expected results.

ANSWERED
ANSWERED

Configure changelog by API version

Hey there! Is it possible to configure a changelog by version? So if I'm looking at the v1 API docs and click on changelog, I see a set of changelogs specific to v1 but if I'm on v2 I only see the v2 changes in the log.

ANSWERED

Numbered lists not displaying?

For some reason, numbered lists are no longer displaying on our page. They show in the editor as normal, but on the live site you can only see an indentation and no number.

Performance issues - How to pass Core Web Vitals

We'd like to move to ReadMe but have concerns about performance of the ReadMe platform and failing Core Web Vitals. This is important given we need to be able to drive organic search traffic to our documentation and will be more critical in March 2024 when Google replaces FID with Interaction to Next Paint (INP).