Ask a Question

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!

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!

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 ?

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>

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. However, the elements don't appear to be added correctly - they don't extend within the pages. Here is the javascript we are trying to add in the Appearance "Custom Javascript" section - am I missing something to make this actually apply to the site script? \` customElements.define('beta-flag', betaFlag); // Re-useable content to beta-flag class betaFlag extends HTMLElement { connectedCallback() { this.innerHTML = ` <blockquote class="callout callout_warn" theme="🚧"><h3 class="callout-heading"><span class="callout-icon">🚧</span><p>Beta Feature</p></h3><p>This feature is available through the Beta program only and is not released for general availability. If you would like to request access to the Beta program, please contact your Account Manager.</p></blockquote>`; } } \`

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. Another built-in issue is that /docs will always show the content of the first doc, so those are two different URLs with the same content. ReadMe is used by most teams I assume to publish documentation online, so that it's easily accessible and searchable. I've reported this to your support team about 4 months ago in September and was told that this is just not supported, but I find it hard to accept that something so trivial and basic cannot be achieved with this product that I love using. Can you please advise how to solve this? 1. Editing meta description separately for /docs, /discussions /changelog, etc. 2. Making sure /docs does not show the same content as the first guide Thanks.

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. It sort of works, however, the published output places the \< symbols around the name-link and the final published output is: <<Analog Informatics Corporation>> And the link points right back to readme, not the link specified in the variable. Is there a way to this? To use variables for the first part and reference it to a link with second variable that works?

Property Names Camel Case

Hi guys, I developed an endpoint that request body xml. Then i set swagger settings Pascal Case ("PropertyName1") like below. <?xml version="1.0" encoding="UTF-8"?> <root> <subRoot> <PropertyName1>string</PropertyName1> <PropertyName2>string</PropertyName2> </subRoot> </root> But when i push to readme, property names are camel case ("propertyName1"). How can i fix this problem ? <root> <subRoot> <propertyName1>string</propertyName1> <propertyName2>string</propertyName2> <subRoot> </root>