PortfolioFy 使用与配置指南

PortfolioFy 使用与配置指南

PortfolioFy 🔥 Dynamically Self Updating Portfolio GitHub Action 项目地址: https://gitcode.com/gh_mirrors/po/PortfolioFy

1. 项目的目录结构及介绍

PortfolioFy 的目录结构如下所示：

.
├── docs/
│   └── ... # 文档文件
├── images/
│   └── ... # 图片资源
├── themes/
│   └── ... # 主题文件
├── utils/
│   └── ... # 实用工具脚本
├── .gitignore
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── LICENSE
├── README.md
├── action.yml
├── generate_index.py
├── localTestingFile.py
└── requirements.txt

• docs/：存放项目文档相关文件。
• images/：包含项目所需的所有图片资源。
• themes/：存放不同主题的样式文件。
• utils/：包含一些项目运行时可能需要的工具脚本。
• .gitignore：指定 Git 忽略的文件和目录。
• CODE_OF_CONDUCT.md：项目行为准则。
• CONTRIBUTING.md：贡献指南，说明如何贡献代码到项目。
• LICENSE：项目开源协议。
• README.md：项目说明文件。
• action.yml：GitHub Action 的配置文件。
• generate_index.py：生成索引文件的脚本。
• localTestingFile.py：本地测试文件。
• requirements.txt：项目依赖文件。

2. 项目的启动文件介绍

generate_index.py 是项目的主要启动文件。该脚本负责生成一个索引文件 index.html，该文件可以用于展示个人项目、文章和活动等。

3. 项目的配置文件介绍

项目的配置主要通过在 GitHub Actions 的工作流中设置环境变量来实现。以下是一些主要的配置选项：

• gh_token：GitHub 个人访问令牌，用于验证和授权操作。
• theme：选择网页渲染的样式级别，可选值为 1 或 2。
• blogs：是否包含博客文章。
• hackathons：是否包含标记为 hackathon 的仓库。
• stats_choice：选择包含的 GitHub 统计类型。
• social_links：是否包含社交媒体链接。
• resume_link：是否包含在线简历链接。
• allow_footer：是否显示页脚信息。
• project_sort_by：项目排序方式，可选值为 stars 或 forks。

这些配置可以在 .github/workflows/ 目录下的 YAML 文件中设置。例如：

name: Latest portfolio
on:
  schedule:
    - cron: '0 0 * * *'
jobs:
  updating-portfolio:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - uses: kaustubhgupta/PortfolioFy@main
        with:
          gh_token: ${{ secrets.TOKEN }}
          theme: 1
          blogs: True
          # 更多配置...

确保在项目的设置中创建了相应名称的 GitHub 秘钥 TOKEN，并赋予了适当的权限。

PortfolioFy 🔥 Dynamically Self Updating Portfolio GitHub Action 项目地址: https://gitcode.com/gh_mirrors/po/PortfolioFy