Discussions

Ask a Question

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?
ANSWERED

Reposition "Did this page help you?" box

I'm curious if there's any user here who was able to reposition/customize the Page Quality CTA buttons ("Did this page help you?")? I would appreciate it if you can share how you guys approached it? Thank you!
ANSWERED

how to resolve time out issue from git hub while uploading large file into github for updating readme

Hi, I am trying to update the readme documentation through git hub actions. it is thrown an error while deploying **We're sorry, your upload request timed out. Please try again or split your file up into smaller chunks.** **Process completed with exit code 1** Please help me to resolve this issue.
ANSWERED

Is it possible to change the contents of the landing page with some markdown and the rdme command line tool?

As per title, thanks

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>
ANSWERED

how to change the name of a response

<https://preview.readme.io/reference/findPetsByTags> like the example above, i want my response (200/404) to have meaning names such as "successful operation". Where can i change that?

Does minItems work?

maxItems works but minItems does not. Despite setting minItems to 1 in my spec for request body parameters I’m able to delete all items in the readme UI
ANSWERED

Bug Fix - Dark Mode - 404 Page Wrong Logo

Love the Dark / Light Mode toggle. I noticed a that if you have a custom "On Dark Logo" for when Dark Mode is on, and then you go to a random URL that is non existent. The dark mode 404 page - Shows the wrong ( On Light ) Logo - Which would look much better if it was the right one.