social-readme

Automatically build Social feeds in your Profile Readme everyday, preview: github.com/zylele

自动构建社交feed到你的主页readme中，预览：github.com/zylele

或者我的博客，“关于我”页面，预览：「关于」 | 乐章

目前支持

rss，符合rss2.0或atom标准，比如我的博客 rss链接是https://zylele.github.io/atom.xml
豆瓣（想看、在看和看过的书和电影，想听、在听和听过的音乐）

更新你的项目readme

根据你的需要，在你的readme中增加以下内容

博客:

<!-- START_SECTION:blog -->
<!-- END_SECTION:blog -->

豆瓣:

<!-- START_SECTION:douban -->
<!-- END_SECTION:douban -->

这些是构建feed信息的识别点

Profile Repository(`<username>/<username>`)

仓库名与你的GitHub用户名相同的，就是Profile Repository

这是GitHub的一个彩蛋，仓库根目录的README.md文件将会被渲染展示在你的个人公共主页上

在你项目的根目录，新建.github/workflows/social-readme.yml，或者编辑其他已有的workflow文件
拷贝以下代码到上一步的文件中，根据你的需要，选填博客atom链接blog_rss_link，豆瓣用户名douban_name（豆瓣个人主页地址可以看到douban.com/people/username/，这里的username）

比如我的Profile Repository是 github.com/zylele/zylele ，README.md将会展示在我的主页上：zylele(Eric)，可以参考如下配置：

name: Social Readme

on:
  schedule:
    - cron: '0 0 * * *'
  workflow_dispatch:
  push:
    branches:
      - master

jobs:
  update-social:
    runs-on: ubuntu-latest
    steps:
      - uses: zylele/social-readme@master
        with:
          blog_rss_link: https://zylele.github.io/atom.xml
          douban_name: znyalor

其他仓库或其他路径文件

同样的，在仓库的工作流文件中增加workflow配置。如果是更新非readme文件，则需要配置file_path参数来指定文件路径，如我的博客的源码仓库，其中关于我页面对应的仓库文件是source/about/index.md，配置如下：

name: Social Readme

on:
  schedule:
    - cron: '0 0 * * *'
  workflow_dispatch:
  push:
    branches:
      - master

jobs:
  update-social:
    runs-on: ubuntu-latest
    steps:
      - uses: zylele/social-readme@master
        with:
          douban_name: znyalor
          file_path: source/about/index.md

完整的可选配置

如果你想定制更多构建细节，在workflow文件中的with有如下可选参数

- uses: zylele/social-readme@master
  with:
    blog_rss_link: # 博客链接
    blog_limit: 5 # blog数量
    douban_name: # 豆瓣用户名
    douban_limit: 5 # 豆瓣最新动态数量
    commit_message: Updated social rss by social-readme # commit说明
    file_path: # 更新非readme文件，填写仓库中的文件路径，如source/about/index.md