自动构建社交feed到你的主页

发表于 阅读次数：

项目地址：social-readme，欢迎点个star～

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

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

image

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

image

目前支持

GitHub主页构建使用方式

1.确认存在Profile Repository(<username>/<username>)项目

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

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

比如我的Profile Repository是 github.com/zylele/zylele ，README.md将会展示在我的主页上：zylele(Eric)

2.修改根目录文件

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

博客:

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

豆瓣:

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

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

2.配置workflow文件

我的GitHub主页参考配置如下：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
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

非根目录readme文件构建使用方式

如我的博客的源码仓库，其中 关于我 页面对应的仓库文件是source/about/index.md

1.修改目标文件

同样的，在目标文件中插入上述的“识别点”

2.配置workflow文件

同样的，在仓库的工作流文件中增加workflow配置。

因为是更新非根目录的readme文件，则需要配置file_path参数来指定文件路径

这里我的配置如下：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
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有如下可选参数

1
2
3
4
5
6
7
8
- 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

Star History

Star History Chart