zoukankan      html  css  js  c++  java
  • GitHub 中 readme 如何添加图片

    一、Readme 是什么

    readme文件一般是放在github 每个repo的根目录下,用来解释、说明本repo的主要内容和相关信息。而且在repo主页进去的时候会被自动加载。一般采用md标记的文本格式。

    二、一些尝试

    md格式的文本插入图片格式一般是:

    ![说明文字](图片地址)

    说明文字在github中一般不被显示出来 —— 但不意味着其他APP解析的时候不显示,要根据情况,比如简书的就会显示。

    这种图片显示的核心,在于地址。比如,我的repo目录clone到本地之后,是d:myproject 这个文件夹。而我的图片存放位置是d:myprojectpicspic1.png

    情况一:绝对路径

    如果我直接在本地的markdown文件中插入以下内容,则显示正确。

    ![pic1](d:myprojectpicspic1.png)

    加载出来之后,就会在文档中显示这个图片。

    情况二:相对路径

    由于我的readme.md在d:myproject eadme.md,所以可以用 . 代替当前目录,使用以下

    ![pic1](./pics/pic1.png)

    则也显示正确。

    但是如果把以上任何一种,push到github中,则都不能正确加载。因为绝对地址是在本地,GitHub的服务器中肯定没d盘这样的路径。而相对路径看起来可行,但是没有考虑到git中特殊的文件管理方式。查了文档之后,正确的方式是这样。

    三、正确姿势

    ![图片说明](https://github.com/你的用户名/你的repository仓库名/raw/分支名master/刚你新建的图片文件夹名称/***.png或者***.jpg)

    用这样的方式,就可以在readme中正确显示了。

  • 相关阅读:
    JavaScript提供了哪些定时器
    谈谈对CSS盒子模型的理解
    我们来谈谈类的加载机制
    谈谈你对ThreadLocal的理解
    谈谈你对线程安全的理解?
    JDK提供的线程池有哪些?实际开发我们该怎么使用?
    Pytest系列(7)
    Pytest系列(6)
    Pytest系列(5)
    Pytest系列(4)
  • 原文地址:https://www.cnblogs.com/heenhui2016/p/10735386.html
Copyright © 2011-2022 走看看