Hey Andrew—this was a great write-up, thank you for sharing! It's one of the most substantial ReadMe API use cases that I've seen 🤩
Wanted to also make you (and fellow readers!) aware of rdme, which is ReadMe's official CLI and GitHub Action. It's essentially a wrapper around the ReadMe API that allows you to quickly set up workflows for syncing OpenAPI definitions and—similar to your bash script—directories of Markdown files to ReadMe.
While we mostly use ReadMe itself as our primary CMS, we find that it is helpful to use rdme for Markdown that lives near our code—I blogged about this if you'd like to read more about how we use it!
Let me know what you think about rdme—we're always looking for feedback and are continuously making improvements (including some that are right around the corner 👀)
Thanks and take care!
-Kanad 🦉
For further actions, you may consider blocking this person and/or reporting abuse
We’re an inclusive community for sharing DevOps and SecOps tips & tricks, tutorials, and career insights.
Hey Andrew—this was a great write-up, thank you for sharing! It's one of the most substantial ReadMe API use cases that I've seen 🤩
Wanted to also make you (and fellow readers!) aware of
rdme, which is ReadMe's official CLI and GitHub Action. It's essentially a wrapper around the ReadMe API that allows you to quickly set up workflows for syncing OpenAPI definitions and—similar to your bash script—directories of Markdown files to ReadMe.Once you have the CLI installed and have your Markdown files ready to go, you'll be able to run commands like this to start syncing your Markdown to ReadMe:
We actually dogfood
rdmeto sync Markdown docs for a few different open-source tools:api(see here for the syncing script)@readme/markdown(see here for the syncing script)rdmeCLI itself! (see here for the syncing script)While we mostly use ReadMe itself as our primary CMS, we find that it is helpful to use
rdmefor Markdown that lives near our code—I blogged about this if you'd like to read more about how we use it!Let me know what you think about
rdme—we're always looking for feedback and are continuously making improvements (including some that are right around the corner 👀)Thanks and take care!
-Kanad 🦉