Discussions
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!
Posted by Chad Brotherton about 1 year ago
Disable click on image
Hiya! Clicking on an image in the Guide opens the image in a popout window. This is helpful if it's a small screenshot, but kinda useless if it's just an icon. Is there any way to turn of click-to-open on images, so the user can't click an image that shouldn't be clicked?
Thanx!
Posted by Alan Baklor about 1 year ago
add summary o description over tag
im working with opeanpi 3.0.3 and i would like to add a custom description for root tag like a "payment link" see image
![](https://files.readme.io/a7a2dba-image.png)
it is posible ?
Posted by Franklin carrero about 1 year ago
Help me! restore deleted devices
Hi !
I have accidently deleted the wrong page and I really don't any way to restore it. Can you please assist?
Posted by Chen about 1 year ago
UUID of API Reference Pages
Hi!
The help for the "Retrieve an entry from the API Registry" for the required UUID property API states:
> An API Registry UUID. This can be found by navigating to your API Reference page and viewing code snippets for Node with the api library.
What does this mean? Do we navigate to the page in the Editing UI? In the external facing page?
Is there more information in the doc about "viewing code snippets for Node with the api library"?
I do find "\_id" in the page source for the API reference page in question, but it returns a 404 when I use that as the UUID.
Thanks for any insight you can provide!
Posted by Chris Cosentino about 1 year ago
How to add one more tab to subheading
I am trying to add one entry on sub heading next to guides , api reference , etc.
Posted by Aniket about 1 year ago
Manage Content as Code (CaC) - Readme Terraform Provider
Our team is heavily reliant on Terraform for Infrastructure as Code. We wanted to be able to manage our Readme documentation in a similar Content-as-Code fashion within our pipelines but there wasn't an easy way to do that. We spent some dev cycles on building a proper TF provider for Readme that enables managing guides, API references, categories, images and so on. We have recently published it to the public domain and welcome feature contributions from the greater Readme community.
[Readme Terraform Provider](https://registry.terraform.io/providers/LiveOakLabs/readme/latest/docs)
Posted by Brant Wellons about 1 year ago
Can I get parent's category name or slug when calling 'getdoc' API?
Hi, I want to get parent's category name or slug when calling 'getdoc' API.
<https://docs.readme.com/main/reference/getdoc>
But, I can only see ids like '64ce3233....' in response and I do not know how to handle them.
Posted by Yunjae Jung about 1 year ago
Must slugs be unique across both doc: and ref: domains?
If we have a Guide topic with a slug of slug-name, can we also have an API reference topic name slug-name (exactly the same)? So in linking, both (doc:slug-name) and (ref:slug-name) would exist.
Or must a slug be unique across both the doc: and ref: domains?
Thank you!
Posted by Chad Brotherton about 1 year ago
Markdown links do not render `[example][1]\n[1]: http://example`
Standard links as supported by Github, Pandok, CommonMark and most other markdown tools don't seem to work in Readme.com, even if the documentation says \["The engine also supports all standard markdown constructs"][1]
\[1]: <https://docs.readme.com/rdmd/docs/syntax-extensions#standard-markdown>
For example from the following 3 links, none will render:
```Text Markdown
Here are 3 styles of links that do not render: [example1][1], [example2][] and [example3][].
[1]\: http://example.com
[example2]\: http://example.com
[example3]\: http://example.com "link to example.com"
```
This style of links if far superior as it doesn't clutter the text with long links. What is the syntax to keep the link text and the URL separated in Readme.com markdown syntax?
CommonMark relevant spec paragraph: <https://spec.commonmark.org/0.30/#link-reference-definition>
Posted by Kevin about 1 year ago