GitHub Profile README 介绍

最近,GitHub 上线了一个全新的个人页功能,可以显示一个自定义的 README.MD 在个人主页。 效果如下:

要激活此功能,需要新建一个与自己 ID 同名的 Repository,新 Repo 里的 README.MD 将出现在你的首页。

hayschan/hayschan is a special repository. Its README.md will appear on your public profile!

hayschan/hayschan 是一个特殊的库。 它的 README.md 将出现在您的公开资料中!

如何创造自己的 README.MD

1. 创建 Repository

创建新的 Repository,仓库名为自己的用户名,形如 仓库名/用户名 -> hayschan/hayschan

2.修改 README.md

修改你的 README.md,可以简简单单介绍下自己,或者加上一些好玩的功能(这步使用 markdown 语言)

这是我的 README文件,可以作为参考。

有趣的项目

下面我介绍下制作主页过程中遇到的一些有趣的项目:

GitHub Profile README Generator

GitHub Profile README Generator

Github Readme Generator

这两个项目可以帮你轻松创建 GitHub Readme 文件,你可以直接复制/粘贴到你自己的 README 文件。

你可以加入诸如标题、字幕、技能、横幅图片、附加信息、社交媒体链接、徽章和GitHub统计等内容。

Github Readme Generator

GitHub Readme Stats

在你的 README 中动态生成的 GitHub 统计信息

初级设置

用法很简单,将这行代码复制到你的 markdown 文件中,更改 ?username= 的值为你的 GitHub 用户名。

[![Anurag's GitHub stats](https://github-readme-stats.vercel.app/api?username=anuraghazra)](https://github.com/anuraghazra/github-readme-stats)Anurag's GitHub stats

将私人项目贡献添加到总提交计数中

你可以使用参数 ?count_private=true 把私人贡献计数添加到总提交计数中。

注:如果你是自己部署本项目,私人贡献将会默认被计数,如果不是自己部署,你需要分享你的私人贡献计数。

选项: &count_private=true

![Anurag's GitHub stats](https://github-readme-stats.vercel.app/api?username=anuraghazra&count_private=true)Anurag's GitHub stats

主题

你可以通过现有的主题进行卡片个性化,省去手动自定义的麻烦。

通过调用 ?theme=THEME_NAME 参数,像这样:

![Anurag's GitHub stats](https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&theme=radical)Anurag's GitHub stats

所有现有主题

dark, radical, merko, gruvbox, tokyonight, onedark, cobalt, synthwave, highcontrast, dracula

预览主题

你可以预览所有可用主题或者签出主题配置文件, 而且如果你喜欢, 你也可以贡献新的主题 😄

Blog post workflow

这个项目可以使用 Github Action 自动抓取 RSS 源的最新文章或者 StackOverflow 活动显示在个人主页。

使用方法

  • 在你的 README 文件中添加以下部分,你可以给任何你想要的标题。 只要你在 README 文件中使用<!-- BLOG-POST-LIST:START --><!-- BLOG-POST-LIST:END -->。Github Action 会用实际的博文列表来替换这个标签。
# Blog posts
<!-- BLOG-POST-LIST:START -->
<!-- BLOG-POST-LIST:END -->
  • 创建Github Action,爬取内容。

  • 在工作流文件夹内创建一个名为blog-post-workflow.yml的新文件,内容如下。
name: Latest blog post workflow
on:
  schedule: # Run workflow automatically
    - cron: '0 * * * *' # Runs every hour, on the hour
  workflow_dispatch: # Run workflow manually (without waiting for the cron to be called), through the Github Actions Workflow page directly
jobs:
  update-readme-with-blog:
    name: Update this repo's README with latest blog posts
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - uses: gautamkrishnar/blog-post-workflow@master
        with:
          feed_list: "https://KiLien.github.io/index.xml"

  • 用你自己的rss feed urls替换上面的url列表。
  • 提交并等待它自动运行,或者你也可以手动触发它以立即看到结果。

类似项目

项目引用

Last Updated: