I have some Markdown files that I want to put in ReadMe, and they use relative links to images in their same directory. How can I make sure those image links still work when putting the Markdown into ReadMe? I have a lot of images, so putting them individually into the widgets will be time consuming.
Posted by Jessica 3 years ago
Hello, the PHP code block will not syntax highlight the code unless it is surrounded by a <?php ?> tags. The code block should already assume I'm inside <?php, since I already selected PHP from the dropdown. Having to add that for every single block is very frustrating.
Posted by Caleb 3 years ago
Hey! Because of the way our system works, we are going to need to push update swagger files to readme. What this looks like manually is me continually updating the Swagger links. I'm worried this won't be scalable. Is there a way for us to push are swagger file updates to Readme automatically? Thanks!
Posted by MacKenzie Alessi 3 years ago
Posted by Jimmy 3 years ago
I am trying to evaluate Readme.io as an API documentation tool, but at the moment I cannot import the Modulr API which is the crucial first step... The swagger url: https://modulr-technology-ltd.cloud.tyk.io/portal/apis/598829b39547c1000111d4f1/documentation/raw The error I get on import is: 'Invalid swagger file...' '...is not a valid JSON schema' I was able to successfully import the 'pet store' swagger (http://petstore.swagger.io/v2/swagger.json) I have validated using a couple of external validation tools, so am not sure why there is an error.
Posted by Gareth Faull 3 years ago
Our API needs two headers, `Accept-Version: v2` and `Authorization: Bearer [JWT]` (where `[JWT]` is a token the user has to fill in). Both are set in our "API Settings" and working as expected when using the "Try It" feature. But the headers are missing from the auto generated code. As a result, the auto generated code does not work as-is. The user has to add the headers manually which is not at all obvious. I _could_ add these headers manually, but doing so for every single endpoint it tedious and error prone. How can I tell readme.io to add the headers to the auto generated code automatically?
Posted by Stefan Schüßler 3 years ago
Hi there, dunno if this is a Feature-Request or Bug. (I'm speaking about **Reference API**.) I believe that if I pin an image to sidebar it should be placed where it was defined. Instead, it is always placed at the very beginning of a page. Pictures will follow in the next comment. Kind regards, Nobo Nadie
Posted by Nobo Nadie 3 years ago
When writing our readme guides in markdown, we break our lines after every sentence or so to increase readability in our editor. However, when I paste these markdown files into the readme.io editor, the html gets parsed in a way that there is a break after each of these line breaks. example: this is a long line so we break it up, but if the browser window is large enough we'd like it to have natural wrapping. Becomes: this is a long line so we break it up, but if the <br> browser window is large enough we'd like <br> it to have natural wrapping. <br> Is there a way to have normal paragraph wrapping in the html without having to put every paragraph on a single line in our markdown files? Usually paragraph breaks are denoted by an empty line in markdown, but that does not seem to be the case here. Thanks!
Posted by Tommy Crumrine 3 years ago
Hi all, Is it possible to have a comments section in knowledge base? it's really convenient for users to ask questions right on the page after reading articale/doc page. If something isn't clear in a documentation, the user can ask the question in the comments section after article and someone can answer for it, later doc owner can collect answers and questions and improve the documentation.
Posted by Mike 3 years ago
I am working with API Settings that are defined in the Reference Settings section (https://dash.readme.io/project/openbouquet/v4.2.53/reference). I have two sets of settings (let's call them, setA and setB). Both have two parameters (token and your_server). Under setA (working), the "your_server" has the type drop-down set with no value, while the "token" has the type drop-down set with Query. setB (not working) has "your_server" defined but it is not possible to choose no type, I must choose Query or Header. "your_server" is used in this way: https://[[app:your_server]]/release/v4.2/rs Also, if I try to change the "setA" settings (for example, call them "setC") then I get the error: "Validation Failed `manual` is not a valid enum value for path `in`." Unfortunately, there is no explanation of how to setup these additional API settings: https://readme.readme.io/docs/additional-api-settings How can I make "your_server" get a type of "none" (or "manual") and get readme.io to accept this parameter?
Posted by Jeffrey Edison 3 years ago
Posted by Philip Arambula 3 years ago