Discussions

Ask a Question
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

Let customers download open api spec

The admin dashboard has a way to export the api to oas spec file But it doesn't seem like there's a way for the public facing api spec page to download an oas json file That would be useful for customers if they prefer exploring the api with tools like Postman etc
ANSWERED
ANSWERED

Download a csv or zip file

Is there a way to embed a download link in the documentation?
ANSWERED

Enum value used as example appears twice in combo box

Hello, When declaring in my OpenAPI spec a field such as: ``` "carColor":{"type":"string","example":"WHITE","description":"Color of the car","enum":["WHITE","BLACK","BLUE"]} ``` ... then the field appears in Readme with a combo box with the possible values: `WHITE`, `WHITE`, `BLACK`, `BLUE`. If I select the first `WHITE` value, it won't be included in the generated JSON in the right pane (it does work with the other values). Is there a way to have this value appear only once, be included in the generated JSON and still keep this value as an example? Thank you, Eric
ANSWERED
ANSWERED

Is there a way to add comments using Readme's markdown?

I'd like to add a comment to a topic in readme that internal users will be able to see, but that will not get picked up and published, such as: .. internal RST comment <!--- internal GitHub markdown comment ---> <!--internal HTML comment--> Is that possible in a ReadMe file? I'm not seeing anything in the markdown reference, and would like to avoid trial and error if possible.
ANSWERED

Quick and easy way to copy paste into a table

Hi! Just wondering if there is an easy way to copy and paste tables from one document (Word, Spreadsheet) into ReadMe?
ANSWERED