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

Discussions

Ask a Question

After updating OAS 2.0 to 3.0 , we are getting slug of null issue while updating readme.io through github? could you provide me the solution for this

build

Bug in rendering descriptions of Schema object that contain Reference Objects inside of allOf

There appears to be a bug in the way ReadMe is rendering descriptions of complex schemas that make use of allOf to combine multiple schema and reference objects.

Disable HTML URL Encoding of headers

Currently we have a token header that will contain a space
When this is added, the example request fills in that header space with an encoded %20 which breaks the sample request. This is the case with all of our docs, where none of the sample requests will work

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?

How to make linebreaks in markdown table cell using raw markdown (not block code)?

Hello, I am syncing .md files to ReadMe for my company's documentation. I am trying to create a markdown table in which the table cell's have line breaks. I have used tags in my markdown code, which works in normal markdown, but doesn't seem to work when I import it into ReadMe. The only way I can seem to get line breaks to work in ReadMe is to use the ReadMe table block. Do I need to change my .md to include that block format or is there another way?

How you will handle sheamless login in Hive blockchain ??

How you will handle sheamless login in Hive blockchain ??

Custom Javascript for reusable content

We are trying to use the custom javascript for our site to hack in some reusable content blocks - theoretically creating a new element that we can add in html content blocks to add the same content to multiple pages.

SEO issues when using ReadMe: Controlling metadata for every single URL + /docs directing to the first doc

We keep getting hammered in SEO audits (and thus panelized by Google) on the fact that I as the content writer cannot control the meta-description for the "sections" in ReadMe (not single docs - sections like /discussions, /docs, etc.). So then either they all have the same metadata description (from the project-level setting), or have to be empty.

Make a variable also a link via another variable

consider [<<coname>>](COURL). The goal is to have a variable for the company name and a variable for the the company's URL. Then when I use them, be able to supply the variable names and have the link work. It seems that variables cannot be active links.

Property Names Camel Case

Hi guys,