The Fantastic GitHub README Guide

Latest Blog Posts (RSS Feed)

You can use a GitHub Action to automatically fetch and display your latest blog posts from an RSS feed directly in your README. This is a powerful way to showcase your recent thoughts and writing without manual updates.

Example Workflow Snippet:

name: Latest blog post workflow
on:
  schedule:
    - cron: '0 * * * *' # Runs every hour
  workflow_dispatch:
permissions:
  contents: write
jobs:
  update-readme-with-blog:
    name: Update README with latest blog posts
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: gautamkrishnar/blog-post-workflow@v1
        with:
          feed_list: "https://dev.to/feed/YOUR_USERNAME"
          max_post_count: 5
          comment_tag_name: "BLOG-POST-LIST"

You would then add a comment block in your README like this:

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

The action will automatically replace the content between the `START` and `END` comments with your latest posts.

Advanced Templating with Dynamic Readme Action

For even more control, actions like "Dynamic Readme GitHub Action" allow you to use variables and include files from other repositories, enabling complex templating for common sections like sponsor links or contact information across multiple READMEs.

Example Syntax:

Hello, I'm ${{ env.REPOSITORY_OWNER }}!
This is my repository: ${{ env.REPOSITORY_FULL_NAME }}