วิธีเพิ่มภาพหน้าจอไปยัง README ในที่เก็บ github?


594

เป็นไปได้หรือไม่ที่จะวางภาพหน้าจอในไฟล์ README ในที่เก็บ GitHub? ไวยากรณ์คืออะไร


1
ทางออกที่ถูกต้องสำหรับเรื่องนี้คือการใช้การอ้างอิงแบบสัมพัทธ์ต่อคำตอบนี้stackoverflow.com/a/11916467/1633251 (ดูความคิดเห็นที่มีลิงก์ไปยังเอกสาร github ใหม่เกี่ยวกับวิธีการทำเช่นนี้) คำตอบสั้น ๆ คือการใช้[Read more words!](docs/more_words.md)
David H

2
โซลูชันส่วนใหญ่เสนอให้ชี้ไปที่ repo เอง ถ้าคุณต้องการหลีกเลี่ยงไบนารีใน repo (แม้ในสาขาแยกตามที่เสนอ) และคุณต้องการเก็บไว้ในสถานที่ภายนอก มีวิธีปฏิบัติที่ดีไหม? ส่วนสำคัญอาจ (IDK ถ้าส่วนสำคัญสามารถเป็นไบนารีหรือเพียงแค่ข้อความ)? กำลังสร้าง repo อื่น "myproject-assets" สำหรับโครงการ "myproject" หรือไม่ ภาพสถานที่ยอดนิยมภายนอกคล้ายกับมาตรฐานจริงของ youtube สำหรับการอัพโหลดวิดีโอ?
Xavi Montero

1
มีความเป็นไปได้ที่ซ้ำกันของการเพิ่มรูปภาพใน README.md บน GitHub
ashokramcse

คำตอบ:


850

หากคุณใช้ Markdown (README.md):

หากคุณมีภาพใน repo ของคุณคุณสามารถใช้ URL ที่เกี่ยวข้อง:

![Alt text](/relative/path/to/img.jpg?raw=true "Optional Title")

หากคุณต้องการฝังภาพที่โฮสต์ไว้ที่อื่นคุณสามารถใช้ URL แบบเต็มได้

![Alt text](http://full/path/to/img.jpg "Optional title")

GitHub แนะนำให้คุณใช้ลิงก์ที่สัมพันธ์กับ?raw=trueพารามิเตอร์เพื่อให้มั่นใจว่าจุด repos แยกได้อย่างถูกต้อง

raw=trueพารามิเตอร์ที่มีในการสั่งซื้อเพื่อให้แน่ใจว่าภาพที่คุณเชื่อมโยงไปยังจะมีการแสดงผลเป็น ซึ่งหมายความว่าเฉพาะภาพที่จะเชื่อมโยงไปถึงไม่ใช่อินเตอร์เฟส GitHub ทั้งหมดสำหรับไฟล์นั้น ๆ ดูความคิดเห็นนี้สำหรับรายละเอียดเพิ่มเติม

ลองดูตัวอย่าง: https://raw.github.com/altercation/solarized/master/README.md

ถ้าคุณใช้ SVGs แล้วคุณจะต้องตั้งแอตทริบิวต์ sanitize ไปเช่นกัน:true ?raw=true&sanitize=true(ขอบคุณ @EliSherer)

นอกจากนี้ยังมีเอกสารเกี่ยวกับลิงก์ที่เกี่ยวข้องในไฟล์ README: https://help.github.com/articles/relative-links-in-readmes

และแน่นอนเอกสาร markdown: http://daringfireball.net/projects/markdown/syntax

นอกจากนี้หากคุณสร้างสาขาใหม่screenshotsเพื่อจัดเก็บภาพคุณสามารถหลีกเลี่ยงพวกเขาอยู่ในmasterต้นไม้ทำงาน

จากนั้นคุณสามารถฝังโดยใช้:

![Alt text](/../<branch name>/path/to/image.png?raw=true "Optional Title")

1
ฉันเพิ่มเอกสารอย่างเป็นทางการในลิงก์ที่เกี่ยวข้อง แต่ฉันไม่สามารถหา repo ที่ใช้พวกเขาได้หากคุณมีข้อเสนอแนะฉันยินดีที่จะช่วยเหลือเนื่องจากประเด็นทั้งหมดคือการช่วยเหลือผู้คนมากขึ้นไม่อยู่ในขอบเขต (ความผิดพลาดของฉันที่นี่)
Paul

2
@Paul นี่คือตัวอย่างที่เก็บของที่ทำเช่นนั้น! github.com/Tarrasch/zsh-bd
Tarrasch

4
github.com/altercation/solarizedเป็นเวอร์ชันที่แสดงผลของตัวอย่างด้านบนในกรณีที่ช่วยใครก็ได้
barrycarter

3
เมื่อคุณพูดว่า/relative/path/to/img.jpgนั่นไม่ใช่เส้นทางที่สมบูรณ์เนื่องจากการเฉือนชั้นนำใช่หรือไม่
jww

1
@kelvin raw=trueพารามิเตอร์มีไว้เพื่อแสดงภาพพา ธ GitHub ชี้ไปที่ไม่ใช่อินเตอร์เฟส GitHub ลองและเห็นความแตกต่าง: github.com/altercation/solarized/blob/master/img/... VS github.com/altercation/solarized/blob/master/img/... URL แรกจะแสดงอินเทอร์เฟซ GitHub และรูปภาพให้คุณในขณะที่ URL ที่สองจะแสดงภาพให้คุณเห็นเท่านั้น ลิงก์สัมพัทธ์ยังคงมีประโยชน์เมื่อทำการโคลน / ฟอร์กกิ้ง repos ดังนั้นใช่คุณควรใช้พา ธ สัมพัทธ์กับพารามิเตอร์นั้น แต่มันเป็นสองแนวคิดที่แตกต่างกัน
Paul

70

แม้ว่าจะมีคำตอบที่ยอมรับแล้ว แต่ฉันต้องการเพิ่มอีกวิธีหนึ่งในการอัปโหลดภาพไปยัง readme บน GitHub

  • คุณต้องสร้างปัญหาใน repo ของคุณ
  • ลากและวางในพื้นที่แสดงความคิดเห็นภาพของคุณ
  • หลังจากสร้างลิงค์สำหรับรูปภาพแล้วให้แทรกไว้ที่ readme ของคุณ

รายละเอียดเพิ่มเติมคุณสามารถค้นหาได้ที่นี่


6
ฉันสนใจว่ารูปภาพจะโหลดด้วยวิธีนี้นานแค่ไหน Github ทำการลบภาพบางภาพหรือไม่? เช่น "ถ้าภาพนี้ไม่ได้อ้างอิงจากปัญหา
Github

1
@Artin อาจเกิดขึ้นเมื่อปัญหาถูกลบโดยสมบูรณ์ ปัญหาที่ปิดติดอยู่ตลอดไปเนื่องจากพวกเขาทำหน้าที่สำคัญมากในการจัดทำเอกสารและการแก้ไขข้อ
ผิดพลาด

55

ฉันพบว่าเส้นทางไปยังรูปภาพใน repo ของฉันไม่เพียงพอฉันต้องเชื่อมโยงไปยังรูปภาพบนraw.github.comโดเมนย่อย

รูปแบบ URL https://raw.github.com/{USERNAME}/{REPOSITORY}/{BRANCH}/{PATH}

ตัวอย่าง Markdown ![Settings Window](https://raw.github.com/ryanmaxwell/iArrived/master/Screenshots/Settings.png)


4
Downvoting เนื่องจาก @sorens แสดงความคิดเห็นในคำตอบที่ยอมรับ ไม่ดีที่จะระบุการอาบน้ำที่สมบูรณ์เนื่องจากมันจะทำงานได้ไม่ดีในที่เก็บแยก (หรือถ้าคุณเปลี่ยนชื่อ repo ของคุณหรือถ้า Github เปลี่ยนชื่อโดเมน ฯลฯ )
Linus Unnebäck

7
@ LinusUnnebäck: มีเหตุผลหนึ่งที่ดีในการใช้เส้นทางสัมบูรณ์ imho: ถ้า readme.md ถูกใช้ในที่อื่นเช่นกันเช่นหน้าหลักของ Doxygen ลิงก์สัมพัทธ์จะไม่ทำงาน
Ela782

1
@ Ela782 ถึงแม้ว่าจะมีข้อสังเกตเพิ่มเติมว่าไม่ควรเป็นปัญหาสำหรับซอฟต์แวร์ที่ฉีกไฟล์ README โดยเฉพาะจาก GitHub ; ซอฟต์แวร์ดังกล่าวควรทราบเพื่อแก้ไข URL สัมพัทธ์อย่างถูกต้อง ตัวอย่างเช่นnpm
Mark Amery

วิธีการเชื่อมโยงไปยังภาพในraw.github.comโดเมนย่อย? จะอัพโหลดไฟล์ภาพได้ที่ไหน?
Saif

@Saif raw.github.com เป็นเพียงภาพสะท้อนของสิ่งที่มุ่งมั่นกับที่เก็บ gitHub ของคุณ เพียงส่งรูปภาพไปยังที่เก็บข้อมูลของคุณและทำตามรูปแบบ URL ที่ระบุ

24
  1. อัปโหลดภาพของคุณไปที่ postimage.org
  2. รับ github Markdown url
  3. แทรกใน ReadMe ของคุณ

2
URL นี้ควรเปลี่ยนเป็นpostimages.org
Indrajith Ekanayake

คุณเป็นคนเดียวที่คำตอบมีประโยชน์กับฉัน
Cypher

21

หนึ่งบรรทัดด้านล่างควรเป็นสิ่งที่คุณมองหา

ถ้าไฟล์ของคุณอยู่ในพื้นที่เก็บข้อมูล

![ScreenShot](https://raw.github.com/{username}/{repository}/{branch}/{path})

หากไฟล์ของคุณอยู่ใน URL ภายนอกอื่น ๆ

![ScreenShot](https://{url})

2
แนะนำให้ใช้ลิงก์ญาติของไฟล์ภาพดูลิงก์ญาติใน READMEs - Github Help
shaobin0604

2
-1 สำหรับเหตุผลที่กำหนดโดย @ shaobin0604; เอกสารอย่างเป็นทางการแนะนำให้ใช้ลิงก์ที่สัมพันธ์กันเมื่อเชื่อมโยงไปยังไฟล์ใน repo ของคุณเองเพื่อให้ลิงก์ชี้ไปยังตำแหน่งที่ถูกต้องเมื่อถูกแยก
Mark Amery

17

ไวยากรณ์ markdown สำหรับการแสดงภาพแน่นอน:

![image](https://{url})

แต่:วิธีการให้urlหรือไม่

  • คุณอาจไม่ต้องการให้ repo ของคุณเต็มไปด้วยภาพหน้าจอพวกเขาไม่มีส่วนเกี่ยวข้องกับรหัส
  • คุณอาจไม่ต้องการจัดการกับความยุ่งยากในการทำให้ภาพของคุณพร้อมใช้งานบนเว็บ ... (อัปโหลดไปยังเซิร์ฟเวอร์ ... )

ดังนั้น ... คุณสามารถใช้เคล็ดลับที่ยอดเยี่ยมนี้เพื่อทำให้ github โฮสต์ไฟล์รูปภาพของคุณ TDLR:

  1. สร้างปัญหาในรายการปัญหาของ repo ของคุณ
  2. ลากและวางภาพหน้าจอของคุณในปัญหานี้
  3. คัดลอกรหัส markdown ที่ github เพิ่งสร้างเพื่อให้คุณแสดงภาพของคุณ
  4. วางลงใน readme ของคุณ (หรือทุกที่ที่คุณต้องการ)

http://solutionoptimist.com/2013/12/28/awesome-github-tricks/


7

ง่ายกว่าการเพิ่ม URL เพียงอัปโหลดภาพไปยังที่เก็บเดียวกันเช่น:

![Screenshot](screenshot.png)



4

markdown: ![Screenshot](http://url/to/img.png)

  • สร้างปัญหาเกี่ยวกับการเพิ่มภาพ
  • เพิ่มภาพโดยการลากและวางหรือเลือกไฟล์
  • จากนั้นคัดลอกแหล่งที่มาของภาพ

  • ตอนนี้เพิ่ม![Screenshot](http://url/to/img.png)ไฟล์ README.md ของคุณ

ทำ!

หรือคุณสามารถใช้ไซต์โฮสต์รูปภาพบางรูปเช่นimgurรับ URL และเพิ่มไว้ในไฟล์ README.md ของคุณหรือคุณสามารถใช้โฮสต์ไฟล์แบบคงที่ได้เช่นกัน

ตัวอย่างปัญหา


ฉันทำสิ่งนี้มานานแล้วตอนนี้ภาพไม่พร้อมใช้งาน ดังนั้นฉันไม่แนะนำสิ่งนี้
Namek

คุณสามารถใช้ imgur หรือ cdn อิมเมจที่กำหนดเองได้ทุกกรณี :)
abe312

4

วิธีที่ 1> วิธีการทำเครื่องหมาย

![Alt Text](https://raw.github.com/{USERNAME}/{REPOSITORY}/{BRANCH}/{PATH})

วิธีที่ 2-> วิธี HTML

<img src="https://link(format same as above)" width="100" height="100"/>

หรือ

<img src="https://link" style=" width:100px ; height:100px " />

หมายเหตุ -> หากคุณไม่ต้องการจัดสไตล์ภาพของคุณเช่นปรับขนาดลบส่วนสไตล์


1

ขั้นแรกให้สร้างไดเรกทอรี (โฟลเดอร์) ในรูทของ repo ในพื้นที่ของคุณซึ่งจะมีสิ่งที่screenshotsคุณต้องการเพิ่ม ลองเรียกชื่อไดเรกทอรีนี้screenshotsกัน วางภาพ (JPEG, PNG, GIF, ฯลฯ ) ที่คุณต้องการเพิ่มลงในไดเรกทอรีนี้

ภาพหน้าจอของ Android Studio Workspace

ประการที่สองคุณต้องเพิ่มลิงค์ไปยังภาพแต่ละภาพใน README ของคุณ ดังนั้นหากฉันมีรูปภาพที่มีชื่อ1_ArtistsActivity.pngและ2_AlbumsActivity.pngในไดเรกทอรีภาพหน้าจอของฉันฉันจะเพิ่มลิงก์ของพวกเขาดังนี้:

 <img src="screenshots/1_ArtistsActivity.png" height="400" alt="Screenshot"/> <img src=“screenshots/2_AlbumsActivity.png" height="400" alt="Screenshot"/>

หากคุณต้องการให้แต่ละภาพหน้าจอในบรรทัดแยกเขียนลิงค์ของพวกเขาในบรรทัดแยก อย่างไรก็ตามจะดีกว่าถ้าคุณเขียนลิงก์ทั้งหมดในบรรทัดเดียวคั่นด้วยช่องว่างเท่านั้น อาจไม่ได้ดูดีเกินไป แต่ด้วยการทำเช่นนั้น GitHub จะจัดเรียงให้คุณโดยอัตโนมัติ

สุดท้ายทำการเปลี่ยนแปลงและผลักดันมัน!


1

ฉัน googled คำถามที่คล้ายกันสองสามข้อและไม่เห็นคำตอบใด ๆ กับปัญหาของฉันและวิธีแก้ปัญหาที่ง่าย

Google Cloud Storage - แนวทางที่แตกต่างกันเล็กน้อยสำหรับรูปภาพใน README

ไปที่นี่: เช่นเดียวกับ OP ฉันต้องการรูปภาพใน Github README ของฉันและรู้ไวยากรณ์ของ Markdown สำหรับการทำเช่นนั้นพิมพ์ใน:

![My Image](https://storage.cloud.google.com/${MY_BUCKET}/${MY_IMAGE}

คุณต้องดำเนินการทดแทนตามจริงด้านบนให้เสร็จสิ้น (เช่น MY_IMAGE = image.jpg) เพื่อให้สิ่งนี้ใช้งานได้

แต่เดี๋ยวก่อน ... ล้มเหลว - ไม่มีภาพถ่ายที่แสดงจริง! และลิงค์ก็เป็นไปตามที่กำหนดโดย Google Storage!

สกรีนช็อตของการอัพโหลดภาพ Github ที่ล้มเหลว

Github camo- รูปภาพที่ไม่ระบุตัวตน

Github โฮสต์ภาพของคุณโดยไม่ระบุชื่อใช่! อย่างไรก็ตามสิ่งนี้นำเสนอปัญหาสำหรับสินทรัพย์ที่เก็บข้อมูลของ Google คุณต้องได้รับ URL ที่สร้างขึ้นจาก Google Cloud Console ของคุณ

ฉันแน่ใจว่ามีวิธีที่ราบรื่นขึ้นเพียงไปที่จุดปลายทาง URL ที่คุณกำหนดและคัดลอก URL แบบยาว รายละเอียด:

คำแนะนำ

  1. เยี่ยมชมคอนโซลการจัดเก็บของคุณ: https://console.cloud.google.com/storage/browser/ $ {MY_BUCKET}? project = $ {MY_PROJECT}
  2. คลิกที่ภาพที่คุณต้องการแสดงใน Github (จะปรากฏขึ้นที่หน้า "รายละเอียดวัตถุ")
  3. คัดลอกพาสต้า URL นั้น (อันที่เริ่มต้นด้วยhttpsไม่ใช่gs) ลงในแท็บ / หน้าต่างเบราว์เซอร์ใหม่
  4. คัดลอกพาสต้า URL ที่สร้างขึ้นใหม่ซึ่งควรยาวกว่าจากแท็บเบราว์เซอร์ / หน้าต่างใหม่ของคุณไปยังไฟล์ Github README ของคุณ

หวังว่านี่จะช่วยเร่งความเร็วและชี้แจงปัญหานี้ให้คนอื่น ๆ


FYI - ดูเหมือนว่ามีบางสิ่งเปลี่ยนแปลงในด้านของ Google หรือ Github ฉันมีภาพบางส่วนใน README ที่ล้มเหลวด้วยวิธีนี้และทำงานบางอย่างในช่วงบ่ายของวันที่ 28 มีนาคม 2020 YMMV ที่นี่!
Jason R Stevens CFA

0

สำหรับฉันวิธีที่ดีที่สุดคือ -

  1. สร้างปัญหาใหม่ด้วยที่เก็บบน github แล้วอัปโหลดไฟล์ในรูปแบบ gif หากต้องการแปลงไฟล์วิดีโอเป็นรูปแบบ gif คุณสามารถใช้เว็บไซต์นี้ได้ที่http://www.online-convert.com/
  2. ส่งปัญหาที่สร้างขึ้นใหม่
  3. คัดลอกที่อยู่ของไฟล์ที่อัพโหลด
  4. ในที่สุดใส่ไฟล์ README ของคุณ! [สาธิต] (ที่อยู่ COPIED)

หวังว่าจะช่วยได้


แตกต่างจากstackoverflow.com/a/32252663/1570104อย่างไร
edelans

0

เพิ่มภาพในพื้นที่เก็บข้อมูลจากตัวเลือกอัปโหลดไฟล์จากนั้นในไฟล์ README

![Alt text]("enter image url of repositoryhere") 

-5

ด้วยภาพที่อยู่ใน/screen-shotsไดเรกทอรี ด้านนอก<div>ช่วยให้สามารถจัดตำแหน่งภาพได้ padding <img width="desired-padding" height="0">จะประสบความสำเร็จโดยใช้

<div align="center">
        <img width="45%" src="screen-shots/about.PNG" alt="About screen" title="About screen"</img>
        <img height="0" width="8px">
        <img width="45%" src="screen-shots/list.PNG" alt="List screen" title="List screen"></img>
</div>

1
สำหรับชีวิตของฉันฉันไม่สามารถนึกภาพในศูนย์กลางของ README ได้ซึ่งคำตอบของคุณมีอยู่ด้วยขอบคุณมาก!
Cody Reichert

ฉันพบว่าคำตอบนี้มีประโยชน์เพราะช่วยให้คุณสามารถกำหนดขนาดของรูปภาพ
Stanley
โดยการใช้ไซต์ของเรา หมายความว่าคุณได้อ่านและทำความเข้าใจนโยบายคุกกี้และนโยบายความเป็นส่วนตัวของเราแล้ว
Licensed under cc by-sa 3.0 with attribution required.