Discussions

Ask a Question
ANSWERED

How to replace example.com from the code snippets, in the language examples?

For example on the api reference page, when looking at the `curl` example ``` Request curl --request GET \ --url https://example.com/api/v0.0.1/schema/ \ --header 'Accept: application/vnd.oai.openapi' ``` Or, the python version: ``` Installation Request import requests url = "https://example.com/api/v0.0.1/schema/" headers = {"Accept": "application/vnd.oai.openapi"} response = requests.request("GET", url, headers=headers) print(response.text) ``` How to replace `example.com`? I saw : https://docs.readme.com/docs/url-paths-in-readme#url-element-descriptions But it didn't really go into any sort of details. I also tried: https://docs.readme.com/docs/passing-data-to-jwt#setting-default-variables-in-the-ui
ANSWERED
ANSWERED

Is there a way to add comments using Readme's markdown?

I'd like to add a comment to a topic in readme that internal users will be able to see, but that will not get picked up and published, such as: .. internal RST comment <!--- internal GitHub markdown comment ---> <!--internal HTML comment--> Is that possible in a ReadMe file? I'm not seeing anything in the markdown reference, and would like to avoid trial and error if possible.
ANSWERED

Syncing via CLI: "Path `category` is required."

Hi there! I'm trying to sync a folder of markdown guides up to Readme. My documents all have the [required header](https://docs.readme.com/docs/importing-documentation#expected-file-format) (title, excerpt) and are otherwise plain markdown in a flat directory structure (ie. they're all in one folder with no subfolders). ``` $ npx rdme docs docs/guides --key={MY_KEY} --version=1.0 > We couldn't save this doc (Path `category` is required.). ``` I'm not really sure what that error message means... Where should I put a category? Should they be in a particular subdirectory?
ANSWERED
ANSWERED
ANSWERED

Let customers download open api spec

The admin dashboard has a way to export the api to oas spec file But it doesn't seem like there's a way for the public facing api spec page to download an oas json file That would be useful for customers if they prefer exploring the api with tools like Postman etc
ANSWERED

Moving a page to a newer version

Hi. Novice user here. I created a new page in a live version of our guide and then made that new page live, not realizing that another editor had already branched a new draft version. Several days later that draft was published, thus removing my new page from our live site. My question is how do I move that page to the new version? I can see that dragging and dropping the page within the old version is easy, but I can't seem to drag it into the new version and republish it live. Do I have to recreate the page in its entirely or is there a way to drag or clone it to the currently live version? Thank you,.
ANSWERED
ANSWERED