Skip to content

Commit b799547

Browse files
authored
docs: embed loom video (#494)
* 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
1 parent fddb614 commit b799547

File tree

1 file changed

+20
-2
lines changed

1 file changed

+20
-2
lines changed

documentation/rdme.md

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -103,10 +103,22 @@ To execute this command via GitHub Actions, the step would look like this:
103103
rdme: openapi [path-to-file.json] --key=<<user>> --id=API_DEFINITION_ID
104104
```
105105
106-
We'll dive into several full GitHub Workflow file examples below!
106+
We'll dive into several full GitHub Workflow file examples (including a video demo) below!
107107
108108
### Example: Syncing an OpenAPI Definition
109109
110+
<!--
111+
This is a custom HTML block that we use in ReadMe.
112+
We'll need this to render an iframe of the Loom video demo.
113+
You can see the video here: https://www.loom.com/share/e32c20a9dc2f4eeeab42d0c18ba24478
114+
-->
115+
116+
[block:html]
117+
{
118+
"html": "<div style=\"position: relative; padding-bottom: 62.5%; height: 0;\"><iframe src=\"https://www.loom.com/embed/e32c20a9dc2f4eeeab42d0c18ba24478\" frameborder=\"0\" webkitallowfullscreen mozallowfullscreen allowfullscreen style=\"position: absolute; top: 0; left: 0; width: 100%; height: 100%;\"></iframe></div>"
119+
}
120+
[/block]
121+
110122
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.
111123

112124
<details>
@@ -224,8 +236,13 @@ To use a GitHub secret in your `rdme` GitHub Action, first [create a new reposit
224236

225237
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.
226238

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.
243+
-->
228244

245+
<!-- prettier-ignore-start -->
229246
```yml Bitbucket Pipelines (bitbucket-pipelines.yml)
230247
# Official framework image. Look for the different tagged releases at:
231248
# https://hub.docker.com/r/library/node/tags/
@@ -245,6 +262,7 @@ sync-via-rdme:
245262
script:
246263
- npx -y rdme@RDME_VERSION openapi [path-to-file.json] --key=<<user>> --id=API_DEFINITION_ID
247264
```
265+
<!-- prettier-ignore-end -->
248266

249267
## Troubleshooting
250268

0 commit comments

Comments
 (0)