
Welcome to the ReadMe Documentation, where you'll find comprehensive guides and community support to help you start working with ReadMe as quickly as possible!
Get StartedSpecifically, a way to generate and store content parts that can be reused throughout the documentation set but do not necessarily display on their own to the end user. Jekyll uses "includes" to accomplish this. See https://jekyllrb.com/docs/step-by-step/05-includes/.
Posted by Jeremy Krane 7 days ago
Please add these features. 1. Preserve Code block language even on page refresh. Either use a query-param to identify which language to show by default or use localStorage to preserve. Please! 2. Once I have changed the language in any code block, why doesn't it change in other code blocks. All snippets in code blocks must be in sync. Please allow this. If it's not possible, is there a workaround? Can we fire any custom JS code to do so? Check these docs - https://developers.vwo.com/reference#server-side-introduction So many code snippets. And we ask someone who uses different languages, that person surely gets confused
Posted by Varun Malhotra 21 days ago
I have made changes in one of the API file, changed it to POST (It was GET previously) and also changed the title of the API, while saving it I am getting an error, error image - https://ibb.co/zQpCZrQ
Posted by Amit Kumar Gupta 21 days ago
Hi! We use the `doc:page-slug` syntax extensively to cross reference pages into our documentation. When I change a page slug, I'm seeing that the existing cross references to that page are not getting updated. Is this an intended behaviour? Thanks
Posted by David Marquis 26 days ago
We're having problem with parsing the OpenApi v3 schema for request body: Unsupported field schema for field CreateUsersInvite: Unknown field type undefined. { "required": [ "email", "first_name", "last_name" ], "properties": { "email": { "type": "string", "format": "email" }, "first_name": { "type": "string" }, "last_name": { "type": "string" } }, "format": "" } Swagger editor is parsing the schema correctly.
Posted by Stevan Milic 28 days ago
If I have two headings with the same name, readme will point to either of them only. For example, Cooking a Banana recipe washing peeling slicing Cooking an Orange recipe washing peeling slicing Readme will link to the first heading washing, peeling, and slicing. No matter what I do, I cannot get readme.io to connect to the correct headings unless I make the headings unique. For example, Cooking a Banana recipe washing a banana peeling a banana slicing a banana Cooking an Orange recipe washing an orange peeling an orange slicing an orange
Posted by Sunil Jadhav 29 days ago
Some of uur API's url say for e.g. ```https://docs.iraservices.io/reference/createaccount-1 ``` are suffixed with -1 as you can see and there are some that dont ```https://docs.iraservices.io/reference/closeaccount```. We deploy our documentation to readme via swagger import and I think the prefix -1 gets added over a period of time and not during the first import. Is there a way to control that as it makes urls inconsistent and that the suffix could be interpreted as version of the api
Posted by Abhilash Raja about a month ago
Hello! We want to import generated by spring-boot (springfox lib) swagger documentation using url but portal is replying Swagger schema validation failed. Data does not match any schemas from 'oneOf' at #/paths//oauth/token/post/parameters/1 Data does not match any schemas from 'oneOf' at #/paths//oauth/token/post/parameters/1 Missing required property: schema at #/ Missing required property: type at #/ Missing required property: $ref at #/paths//oauth/token/post/parameters/1 JSON_OBJECT_VALIDATION_FAILED This is happening when we add oauth/token endpoint into spec. The rest endpoints are fine. Also I would like to know which libraries are you using so we can integrate it into our build process to identify incompatibility issue during build time rather in runtime I would like to discuss details via email please. Thank you
Posted by Ozan Wallet about a month ago
I am adding a login button to the readme.io which generates an JWT stored on a cookie. I was wondering if there is a way to add either the cookie to the header or use the cookie content to pass as an Authorization header.
Posted by Vicenzo Guilherme naves about a month ago
Hi, Understood that there is a recent update on Changelog via here: https://docs.readme.com/docs/changelog However, this backward incompatible update just destroy what we were purposely using it in the past. See: https://docs.abivin.com/changelog/may-31-2019-deployment-notes (No color on item, new posts are inconsistent with old posts) Even with Readme v2.0, the Changelog now just has 2 posts, which mean you have to remove all of the old posts. Why update with such rapid change?
Posted by Long Pham about a month ago
When I have a numbered list, the list items have an indentation (i.e. numbers 1 and 2 here: https://docs.codat.io/docs/myob-accountright-live). However, when this is separated by an image or callout etc, then you lose the indentation (i.e. numbers 3, 6 and 7 in the first section here https://docs.codat.io/docs/myob-accountright-live). Please can you let me know how to keep the consistent formatting with the indentation, even whilst separated by images/callouts/other objects please? Thanks, Callum
Posted by Callum Taylor about a month ago
I am running this and am getting an error I don't understand. rdme swagger swagger/v1/swagger.json --key=XXXXXXXXXX {"error":"Validation failed: slug: Page slug must be unique."} Any chance you can help me figure out how to do this?
Posted by Bubba about a month ago