📜  github add image readme - Shell-Bash (1)

📅  最后修改于: 2023-12-03 15:15:19.945000             🧑  作者: Mango

Github中如何添加图片到Readme文件

在Github上编辑readme文件是开源社区中一个非常重要的事情,因为它可以帮助其他人理解你的项目。在这个过程中,很多时候我们需要添加图片到readme文件中。本文将介绍如何通过Shell-Bash命令来添加图片。

准备工作

在添加图片之前,我们需要先将图片上传到Github仓库中。当我们将图片上传到仓库中后,Github会自动生成一张图像的链接,我们可以使用该链接来引用图片。我们需要复制该链接,并使用Markdown语法在readme文件中插入图片。

步骤
  1. 打开Github仓库,选择需要修改的readme文件。

  2. 点击readme文件的编辑按钮。

  3. 在readme文件中的适当位置,使用Markdown语法插入图片。例如:![alt text](image.jpg)

    其中,alt text是在图片无法显示时显示的文本,image.jpg则是你在 Github 中上传的图片名称。

  4. 粘贴图片的链接到上面的Markdown语法中。

    如果你是使用Linux或Mac OS X操作系统,可以使用curl命令将图片上传到Github仓库,并将图片链接添加到readme文件中。以下是一个简单的 Bash 脚本示例:

#!/bin/bash

echo "Enter image name:"

read imagename

echo "Enter commit message:"

read cm

echo "Enter branch name:"

read branch

curl -u "username:token" -X PUT https://api.github.com/repos/username/repository/contents/path/to/image/$imagename.jpeg \
        -H 'Content-Type: application/json' \
        -d '{"message": "'"$cm"'","branch": "'"$branch"'","content": "'"$(base64 $imagename.jpeg)"'"}'

echo "https://raw.githubusercontent.com/username/repository/$branch/path/to/image/$imagename.jpeg"

其中,你需要将 "username:token"username/repository 替换为你自己 Github 的用户名和仓库名称。 $imagename 是你想要上传的图片名称,$cm 是你为你的提交所写的消息,$branch 是你正在使用的 Git 分支。

运行脚本后,将会显示生成的图片链接,你可以将其复制并粘贴到readme文件中适当的位置即可。

结论

通过以上步骤,你现在应该知道如何使用Shell-Bash命令在Github中添加图片到Readme文件。这将使你的项目更具有吸引力,更易于被其他人理解和使用。