Discussions
Support for Mermaid or other Markdown-generated images?
Hey Readme team,
Sometimes (more like all the time) when I'm documenting, I'd love to illustrate data flows or ideas with a diagram. Now I _could_ draw something up and insert a picture, but this adds load times, doesn't play nice with dark themes and generally adds bloat to my writing flow.
Now I think Github does a great job at supporting Mermaid - a way to describe a diagram in markdown that then gets rendered in the document. <https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-diagrams>
I think this would be a nice addition to readme, too. What do you think?
Posted by Hannes Reinberger 11 months ago
Readme pages are not indexed by search engine.
We recently launched our website and discovered that none of our published articles are searchable by Google. This is because there is no sitemap available for readme pages, so Google won't index them. Our temporary solution is to manually create and update a sitemap.xml every time a new article is added, but this is very cumbersome.
Have you experienced the same problem? Is there a workaround for it?
Posted by Andrei 11 months ago
Please add option to set light/dark theme to Same as System on iPhones when using Safari browser
Currently it is not possible to set theme to Same as System on iPhones when using Safari browser.
On Android phones you can press and hold theme icon button and there will be "Same as System" option.
Unfortunately the option does not show up when using iPhone Safari browser. Please fix it! :)
Posted by He-man Trousers 11 months ago
Are you planning to include Chat GPT capabilities to generate answers based on an existing documentation in Readme?
We have extensive product documentation on Readme and would love to learn how we can potentially use Chat GPT to generate answers for our customers and customer support agents.
Posted by Pamela Alvarez 11 months ago
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 ]`
Posted by null 11 months ago
How to add Headings in Table of contents from custom HTML in markdown
1. I have created a new page in Guide.
2. I used '/Custom HTML' block and added a h4 tag in the HTML.
3. How can I get this heading to appear in 'Table of contents'
Posted by Tejas 11 months ago
How to track search events?
Hi - i have implemented the Segment integration and I am surprised not to see search events being sent to segment.
Unless I missed something or I am the only one interested in such data, I was wondering if there was a plan to add such events to the segment integration.
I am interested in sending search events to destinations:
- [AnyTrack attribution platform](https://anytrack.io)
- [Hubspot](https://hubspot.com)
Posted by Francois 11 months ago
Getting "local issuer certificate" error
When I run the command to upload a new file (or even a simple command such as npx rdm version --key=), I get the following message: request to <https://dash.readme.com/api/v1/version/v2023.1.4> failed, reason: unable to get local issuer certificate. I saw some suggestions about turning off strict SSL checking, but that didn't work. Any ideas?
Posted by Rich Calaway 11 months ago
Can I programmatically embed recipes?
Our company currently syncs the content of our ReadMe docs from a Git repository using the `rdme` client. Is there a way to embed our recipes in our markdown files programmatically so developers do not have to go into the readme UI to add recipes?
Doc: <https://docs.readme.com/main/docs/recipes#embed-into-relevant-endpoints>
Posted by [email protected] 11 months ago
when adding a few code snippets in a doc, can the user select automatically the same coding language in all snippets?
```c
blabla
```
```java
kjcdhc
```
```c
bfndghhgm
```
```java
lkjjln
```
so it will look like these snippets in sync of the language
Posted by null 12 months ago