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>`; } } \`
ANSWERED

Discussion API

Is there a way to post questions to the community discussions forum via the readme api?
ANSWERED

Editor woes

It appears that legacy editor no longer saves content correctly (or sometimes at all) Then new editor freezes when trying to change the type of a code block. Did you bother testing any of this?

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

Run Python code within docs

Can I have a try it button for python code. as it is built for API calls?
ANSWERED

Array property items with oneOf $ref lists supported?

I have a OpenAPI definition that renders as expected when using another openapi viewer called StopLight . I'm trying to load this yml file to our readme site and am encountering an issue with the UI not rendering correctly for array properties using oneOf with $ref's. The property in question is defined like the following: `. configuration_options: type: array description: List of configuration options to present to users when they configure your adapter. The values the user entered for these configuration options will included in the payload send to your webhook_url when your adapter is invoked. items: oneOf: - $ref: "#/components/schemas/StringConfigurationOption" - $ref: "#/components/schemas/RegExConfigurationOption" - $ref: "#/components/schemas/PasswordConfigurationOption"` The UI that is generated for this property does not render the item references correctly. It renders the array portion ok, offering the Add button with a panel for each valid schema allowed for the configuration_options array, but it does not correctly render the shape of each of these schemas if you click to add one. It renders the description but does not display the shape of the ref'ed schema. It simply shows an "Add Field" panel that allows the user to add a key/value rather than the actual defined schema properties. Below is an abbreviated sample of what the StringConfigurationOption looks like (and it's abstract parent): `AbstractConfigurationOption: type: object description: A single UI component that the user will utilize to enter any configuration values that your adapter will require to function. properties: name: type: string description: The name of the configuration option that will be passed to your webhook. example: client_code label: type: string description: The name of the option that will be displayed to the user. ` `StringConfigurationOption: title: StringConfigurationOption type: object description: A UI component that accepts string user input. allOf: - $ref: "#/components/schemas/AbstractConfigurationOption" - type: object properties: config_type: type: string enum: [ string ]`
ANSWERED

Not found because of proxy error: Error: connect ECONNREFUSED

copy curl command use in local terminal is valid
ANSWERED
ANSWERED

What is the best practice for using Changelog for releases?

There seems to be no way to categorize changes. Categories could include functional areas or types of changes. Tags would be another great way to include ways for people to search specific areas of interest.