README自动生成工具readme-scribe使用教程

README自动生成工具readme-scribe使用教程

readme-scribe A GitHub Action that automatically generates & updates markdown content (like your README.md) 项目地址: https://gitcode.com/gh_mirrors/re/readme-scribe

1. 项目介绍

readme-scribe 是一个GitHub Action，它能够自动生成和更新markdown内容，例如项目的README.md文件。这个工具可以帮助项目维护者自动化文档的生成和更新过程，确保项目信息的准确性和时效性。

2. 项目快速启动

要使用readme-scribe，请按照以下步骤操作：

1. 创建一个markdown模板文件（例如templates/README.md.tpl），并将其放置在你希望自动更新的仓库中。
2. 前往GitHub个人设置中，生成一个新的个人访问令牌（Personal Access Token），确保勾选了必要的API权限（如read:user, repo:status, public_repo, read:org）。
3. 在你的仓库设置中创建一个新的秘密（secret），命名为PERSONAL_GITHUB_TOKEN，并将生成的令牌值粘贴进去。
4. 在你的仓库中创建一个新的GitHub工作流文件（例如.github/workflows/readme-scribe.yml），并添加以下内容：

name: Update README

on:
  push:
  schedule:
    - cron: "0 */1 * * *"

jobs:
  markscribe:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@master
    - uses: muesli/readme-scribe@master
      env:
        GITHUB_TOKEN: ${{ secrets.PERSONAL_GITHUB_TOKEN }}
      with:
        template: "templates/README.md.tpl"
        writeTo: "README.md"
    - uses: stefanzweifel/git-auto-commit-action@v4
      env:
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
      with:
        commit_message: "Update generated README"
        branch: main
        commit_user_name: "readme-scribe 🤖"
        commit_user_email: "actions@github.com"
        commit_author: "readme-scribe 🤖 <actions@github.com>"

确保将main替换为你的默认分支名称（如果使用的是master，则需相应调整配置）。

3. 应用案例和最佳实践

以下是一些使用readme-scribe的案例和最佳实践：

• 自动更新项目状态和统计信息，如star数量、fork数量等。
• 定期生成包含最新项目动态的README，确保信息准确无误。
• 结合readme-scribe和其他GitHub Action，自动化整个项目的文档维护工作。

4. 典型生态项目

目前，readme-scribe已经在多个开源项目中得到了应用，以下是一些典型的生态项目：

• muesli/markscribe
• arthurlutz/markscribe

通过上述教程，你可以开始使用readme-scribe来自动化你的项目文档维护工作。

readme-scribe A GitHub Action that automatically generates & updates markdown content (like your README.md) 项目地址: https://gitcode.com/gh_mirrors/re/readme-scribe