rdme
rdme copied to clipboard
ReadMe's official command-line interface (CLI) and GitHub Action 🌊
We use rdme to sync our API specs with ReadMe. We have a build job set to run in Jenkins/CloudBees that runs the following command for several specs when content...
## 🧰 Changes Extends CI to begin running unit tests against Windows and on all of our supported versions of Node. This was really frustrating to get working because most...
I might be alone in this, but I would really love to have the CLI infer the category > page > child page relationship based on the structure of the...
Hello team, I would like to parametrize the category in markdown headers that are synced with Readme.com using Github Actions. I have tried the following: - ${CATEGORY_ID} - {{ process.env.CATEGORY_ID...
It could be interesting to have a configuration flag to only sync Markdown files which match the requirements to be uploaded. *Why is this useful?* In your example you have...
| 🚥 Fix RM-XXX | | :-- | ## 🧰 Changes Added the `--matchOnTitleAndVersion` parameter to the `openapi` command. This allows for an API Specification to be updated based on...
Been seeing this error when running tests in GitHub Actions CI for a bit now: ``` Failed to write coverage reports: ERROR: Error: ENOENT: no such file or directory, open...
# Background - *OS*: `Mac OSX 12.2.1` - *rdme*: `7.2.0` # Symptom See the error described in #497. # Description I may be doing something wrong, but it seems like...
# Background - *OS*: `Mac OSX 12.2.1` - *rdme*: `7.2.0` # Symptom Running `rdme docs ./folder --key --version ` where the category ids in the YAML Front Matter Blocks are...
I am currently trying to create one-way sync from Github to Readme so our repo is source of truth. I am running into an error trying to sync pages after...