Discussions
Create an inline link that opens in a new tab
Please, in the editor, how can I create an inline link (that is, within the text block) that opens in a new tab?
`[page](url){:target=“_blank”}` doesn't seem to work.
Posted by Elias 11 months ago
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.
Posted by Maya Mandel over 1 year ago
custom verifyWebhook
readmeio SDK is not supported in Golang. Can I create my own method that will verify the readme signature?
I can take it from request and then compare to my readme secret taken from env variable I suppose. But which hashing algorithm should I use to compare these values?
I added a feature request for supporting the Golang... I am not sure if this is something that will be implemented in the near future but If not - I would like a way to do this.
Posted by Lorena 10 months 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
All supported markdown headers?
Is there a list of all supported readme-flavored markdown headers on one of your help pages? I know of title, slug, excerpt, category, order, and hidden.
Thank you!
Posted by Chad Brotherton about 1 year ago
Are there any plans for snippet support?
Unless I'm mistaken I can't find any official support for snippets, is there any support for this planned in the future?
I can kind of get around the issue by using Variable Defaults, but obviously this isn't the intended use so I'd rather avoid if possible.
Posted by Steven over 2 years ago
Exclude a project from search?
Is there a way, with an Enterprise project group, to exclude a certain project from being included in site-wide search? Or is my only option to remove that project from the group?
Posted by Janet Swisher almost 3 years ago
Is there a way to filter endpoints by User role?
We have a OAS file with multiple endpoints , I was wondering if there is a way to display some of these endpoints by user role.
Thanks in advance.
Posted by Carlos over 1 year ago
Can i see the new editor
Can i see the new editor
Posted by efe almost 2 years ago
On the changelog page, is it possible to change the amount of content that shows?
How do I control how much is shown on the changelog summary page?
Seems to awkwardly cut stuff off.
Posted by [email protected] over 1 year ago