You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* docs: add loom video embed
* docs(loom): try another embed technique
* docs: lede, formatting
* style: line break
* fix: use custom HTML block to render it instead
GFM doesn't allow iframes: https://github.github.com/gfm/#disallowed-raw-html-extension-
But ReadMe does, via the custom HTML block. Let's just use that since it looks a lot nicer.
* revert: ugh
I hate that my markdown formatter does this lol
* fix: prettier ignore
To sync an OpenAPI or Swagger definition, you'll first want to obtain a unique API definition ID from ReadMe so we know which definition you want to update on subsequent re-syncs. You can obtain this API definition ID in one of several ways, but we'll dive into two below: uploading a file directly into the ReadMe dashboard and using the `rdme` CLI locally.
111
123
112
124
<details>
@@ -224,8 +236,13 @@ To use a GitHub secret in your `rdme` GitHub Action, first [create a new reposit
224
236
225
237
Since `rdme` is a command-line tool at its core, you can use `rdme` to sync your documentation from virtually any CI/CD environment that runs shell commands—[Bitbucket Pipelines](https://support.atlassian.com/bitbucket-cloud/docs/get-started-with-bitbucket-pipelines/), [GitLab CI/CD](https://docs.gitlab.com/ee/ci/), you name it! You can do this by invoking `rdme` with `npx -y rdme@RDME_VERSION` in a Node.js environment. See below for several examples.
226
238
227
-
<!-- Note: the two code blocks below must be joined, despite what VS Code's formatter tells you!-->
239
+
<!--
240
+
The two code blocks below must be joined (i.e. no newline in between) in order to render as tabbed code blocks in ReadMe.
241
+
242
+
Unfortunately we need to ignore both code blocks entirely so Prettier doesn't separate them.
0 commit comments