How to Embed Your Latest Blog Posts and Articles into GitHub Profile README

1. Finding Your Blog’s Native RSS Endpoint

Almost every modern publishing platform provides a public RSS feed URL that outputs standardized XML data. You do not need any special API keys:

2. Step-by-Step GitHub Actions Workflow

Create a new workflow file at .github/workflows/blog-sync.yml inside your username/username repository:

name: Sync Blog Posts to Readme

on:
  schedule:
    - cron: '0 0 * * *' # Executes daily at midnight UTC
  workflow_dispatch: # Allows manual trigger from Actions tab

permissions:
  contents: write # Grants GITHUB_TOKEN write access to commit changes

jobs:
  sync-posts:
    name: Pull RSS and Update Markdown
    runs-on: ubuntu-latest
    steps:
      - name: Checkout Repository
        uses: actions/checkout@v4

      - name: Fetch RSS Feeds
        uses: gautamkrishnar/blog-post-workflow@v1
        with:
          feed_list: "https://yournewsletter.substack.com/feed, https://dev.to/feed/yourhandle"
          max_post_count: 5
          date_format: "mmm d, yyyy"
          template: "$newline- 📄 [$title]($url) - *$date*"

3. Markdown Markers & Custom Template Tokens

Inside your README.md, place the opening and closing HTML comment tags:

### ✍️ Latest Articles & Technical Deep Dives

<!-- BLOG-POST-LIST:START -->
<!-- BLOG-POST-LIST:END -->

The template parameter supports powerful interpolation tokens to customize the generated Markdown output:

• $title: The sanitized title of the blog post.
• $url: The direct canonical link to the article.
• $date: Formatted publication date according to date_format.
• $description: Short summary or excerpt of the article.
• $newline: Inserts a newline break between feed items.

4. Troubleshooting Common Sync Failures