Discussions

Ask a Question
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). Is this a known issue and are there any recommendations to be able to get a ReadMe powered site to pass Core Web Vitals? <https://docs.readme.com> fails and other sites known to use ReadMe have even poorer metrics ![](https://files.readme.io/7e63b6b-image.png)

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.

Uploading valid OPENAPI json file shows only endpoints on the left side

The UI is showing all the API endpoints but they are empty

Get total page views

Response: Internal Server Error Is there any bugs in this endpoint?

How to show body content below OpenAPI definitions

I uploaded OpenAPI definitions with a yaml file, and I also want to edit the UI to add some body content (a table) below the definitions (i.e. the parameter section). But the body content only shows up above the definitions. Can this be changed? Thank you!

Hiding Internal APIs coming from Swagger 2.0 spec

Hi! I was wondering if there is a supported extension or way to hide internal APIs coming from a Swagger 2.0 spec? We want them to be in the Open API spec, but dont wont it be be publicly visibile in our API documentations since it could cause confusion. Thanks!
ANSWERED

Docs pages for logged in users

I have two questions: 1. Is it possible to create pages that only logged users can see? 2. Is it possible, within a page, hide content that only logged users can see?
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?
ANSWERED

Hide the login button on the header

Hi Is there any way to hide the login button on the header? ![](https://files.readme.io/146d766-image.png) Thank you!