Discussions
API Setup before markdow texts
When creating an API endpoint, I would like to start with the API setup and body params. After that, I would like to include complementary information, for example, a table with the response body params, table of errors or other aditional info.
But... When I publish the page, all this markdown info goes to the top, and the API setup and boby params goes to the end of the page. How can we change this order?
Posted by Mateus about 2 years ago
PR into preview?
Is it possible to have a PR auto-generate a preview app in Readme? I know merging can automatically make updates to the site, but I'd love a way to preview a change before it hits production.
Posted by Scott McClellan about 2 years ago
Discussion Forum Moderation
We are considering enabling the Discussion feature. Does it have a way to moderate discussion posts before they appear publicly?
Posted by Mark about 2 years ago
How do I enable 2 options with separate field examples like on this page?
<https://developers.circle.com/v0.9/reference/dda-transfers-create>
[block:image]
{
"images": [
{
"image": [
"https://i.imgur.com/CdwJjnn.png",
null
]
}
]
}
[/block]
[block:image]
{
"images": [
{
"image": [
"https://i.imgur.com/lWCFYeT.png",
null
]
}
]
}
[/block]
Posted by Kenneth about 2 years ago
How do I insert an animated gif? it works fine in Google docs and Word.
I tried the Image button and then Upload an image, but nothing happens
Posted by Barbara Sher about 2 years ago
Line endings in API body
Hi there,
I'm trying to set up an integration for my company's readme documentation that will programmatically publish updates made in our internal tool. I've been able to leverage the Update Docs endpoint to almost satisfy the usage; the only issue is that I can't seem to find any way to encode line endings or line breaks into the body.
So far I've tried "\\n" - doesn't parse as a new line at all, "%0A" or "&x0A" - both just rendered as plain text, and "<br />" - parses to a new line, but doesn't escape other styling from the previous line. Ex:
```
## Here's a Header!<br />This text should be regular paragraph text but is styled as a header
```
Is there a different encoding I can use to transmit line endings? Is there a different way to programmatically publish these docs?
Thanks
Posted by [email protected] about 2 years ago
Example values and enumerations
Hello, how do I manually edit an API reference to include example values enumerations for a body parameter?
Posted by Sophia Ho about 2 years ago
Error 1014 on CloudFlare...
I tried using custom domain feature, and got the error:
Error 1014 Ray ID: 6ebf8bf82d33788b • 2022-03-14 19:51:54 UTC
CNAME Cross-User Banned
The recipe on documentation page did not help (that is disabling proxy did not work.)
My page is on CloudFlare, and I do not want to switch. What to do?
Posted by [email protected] about 2 years ago
Readme API to fetch Project API keys
Hi
Is there any readme.io API to fetch the Project API keys?
Thanks
Rishav
Posted by Kumar Rishav about 2 years ago
File Attachments?
Is there a way to embed a file for downloading? - Im trying to attach data dictionaries that are easier to distribute in Excel - and I want to leave a link in there - but I still want to have it secured behind the login.
Posted by Michael Hoey about 2 years ago