<!--Hello curious raw Markdown reader! 👋
This Markdown page is syncing to ReadMe via the `
rdme` GitHub Action 🦉
Check out the full example below,
and peep the resulting page in our docs: https://docs.readme.com/docs/github-actions-docs-exampleWe also do some fancy little find-and-replace action to swap out every instance
v8` below with the latest version of rdme.
Check out `
.github/workflows/docs.yml` for more info on this!-->
Do you have Markdown files stored on GitHub? With [the `
rdme` GitHub Action](🔗), you can sync them to ReadMe every time they're updated in GitHub. Let's go over how to set this up!
## "Automagical" Workflow File Generation
To set up a GitHub Actions workflow for syncing a directory of Markdown docs, the fastest and easiest way to do so is by running the following command on your local machine:
This will scan the directory for Markdown files, sync them to ReadMe, and then create your GitHub Actions workflow file. Once that's done, create your [repository secret](🔗), push your workflow file to GitHub, and get syncing! 🎊
## Constructing a GitHub Actions Workflow File By Hand
Wait — there’s an easier way to do this!
The information below is useful if you have experience using GitHub Actions, but for most folks, we recommend using the steps [detailed above](🔗). The `
rdme` CLI will ask you a few questions before automatically creating the GitHub Actions workflow file for you, complete with every parameter you need to get syncing.
In order to construct the file by hand, you'll first want to grab a project version to ensure that your docs sync to the right place in your developer hub. That version will be passed via the `
--version` flag. See below for a full example:
In the example above, every push to the `
main` branch will sync the Markdown contents of the `
documentation` directory to version 2.0 of your ReadMe project.
Note that `
@v8` (used in the above example) is the latest version of `
rdme`. We recommend [configuring Dependabot to keep your actions up-to-date](🔗).