Discussions

Ask a Question
ANSWERED

How to "Add Markdown Content" to OpenAPI content?

Hello, I am interested in the following feature, but it's not clear to me how to actually do this: <https://docs.readme.com/main/docs/openapi#adding-markdown-content> Can anyone point me to instructions for how to actually accomplish this? Please note that we manage all of our content in a GitHub repo and use the CLI to import both markdown files and the OpenAPI JSONs, so I'd need to know the flow for how to use this feature given our constraints. Thank you all for your time!
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?

Slow loading endpoints

Hello there. I have the following issue.. L5 swagger openapi endpoints imported into readme via file load very slow. My question is does the file size matter, because when smaller sized file is imported every endpoint loads fast. And if the larger file is imported the endpoints load too slow? Thank you in advance !
ANSWERED

Editor widget issues

Hey, I've been trialling the product and I noticed that all the widgets in the editor (image, table, etc.) don't seem to work - they are greyed out and just "bounce" when I click on them. I've seen there is a current issue with the Cloudflare API, could that be causing the issues? Related to this - when the widgets are working correctly, should I be able to upload images directly in the editor or do I need to host on an external URL (which I think I need to when editing with Markdown only)?
ANSWERED

allowedProjects visibility on global landing page

I have an Enterprisegroup in which there is a project1, and linked project named project2. project1 and project2 are made private. Now when I open <https://enterprisegroup.readme.io>. I see the default global landing page with project1 but not project 2. This is before login. BTW, I have made login as custom login withAuth0. Now from Auth0 I am sending the JWT token in which this exists allowedProjects:[{ subdomain: 'project1', access: 'readonly' },{ subdomain: 'project2', access: 'readonly' }] But post login, I am not able to see project2 at all. Is there something I am missing here?
ANSWERED

Is there an image libarary—a way to view all the uploaded images in my project?

I want to be able to add an image on a page that functions like a button, where if i click it, it opens a specified topic. I can do this in an HTML macro, but only if I have the image elsewhere on the page, whose path I can identify in Raw text mode. It would be easier if there were a place where i could view a library of images in the project. Is this possible?
ANSWERED

Upload text to top-level (tag) pages via API

Hello, We like the fact that text can be added to the category page for a set of endpoints grouped by tag (e.g., https://docs.capablehealth.com/reference/questionnaires-1). Ideally we'd like to be able to upload text to those pages via your API. I wondered if you have any plans for such a feature? Or maybe it's possible now and we just haven't understood how? Thanks. Zeke Pfeifer, Capable Health

API Endpoint Request and Response Parameters are no longer showing all of a sudden

I just noticed today that all of a sudden, request and response parameters are no longer showing up in the API endpoint documentation pages. There were no recent changes to our OAS file. Previously, all of our endpoints rendered request and response parameters on the readme.com generated site, so this is a recent breakage. I checked that uploading our OAS file to another OpenAPI documentation generator (swagger.io) correctly renders the API endpoint request and response parameters. I also manually double checked the OAS file to see that the request and response parameters were correctly documented according to OpenAPI specification (we are using open api 3.1.0). I double checked all of the settings page on readme.com to ensure we didn't disable some kind of setting. What am I missing?

Can we link the two different contents on the same URL page?

Can we link the two different contents on the same URL page with each other?

Email notifications for password protected sites

Is there a way to get email notifications upon changes for password protected sites? (RSS will not work)