GitHub Actions Example: Syncing Markdown

🚧

Deprecated Guidance

This example is only applicable for projects that are still on our legacy project architecture and have not yet migrated to ReadMe Refactored. The legacy project architecture requires rdme@9. You can find more info in our rdme migration guide or by reaching out to us at [email protected].

Please check out this page for an updated example.

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:

rdme docs [path-to-directory-of-markdown] --github

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:

name: Sync `documentation` directory to ReadMe

# Run workflow for every push to the `main` branch
on:
  push:
    branches:
      - main

jobs:
  sync:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout this repo
        uses: actions/checkout@v4

      # Run GitHub Action to sync docs in `documentation` directory
      - name: GitHub Action
        # We recommend specifying a fixed version, i.e. @v9
        # Docs: https://docs.github.com/actions/using-workflows/workflow-syntax-for-github-actions#example-using-versioned-actions
        uses: readmeio/rdme@v9
        with:
          rdme: docs ./documentation --key=${{ secrets.README_API_KEY }} --version=2.0

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.

📘

Keeping rdme up-to-date

Note that @v10 is the latest version of rdme, which only supports projects on ReadMe Refactored. The examples on this page use @v9, which is only applicable for legacy projects. We recommend configuring Dependabot to keep your actions up-to-date.