¿Cómo agregar capturas de pantalla a archivos README en el repositorio de github?
¿Es posible colocar una captura de pantalla en un archivo README en un repositorio de GitHub? ¿Cuál es la sintaxis?
Si usa Markdown (README.md):
Siempre que tenga la imagen en su repositorio, puede usar una URL relativa:
![Alt text](/relative/path/to/img.jpg?raw=true "Optional Title")
Si necesita insertar una imagen alojada en otro lugar, puede utilizar una URL completa
![Alt text](http://full/path/to/img.jpg "Optional title")
GitHub recomienda utilizar enlaces relativos con el ?raw=true
parámetro para garantizar que los repositorios bifurcados apunten correctamente.
El raw=true
parámetro está ahí para garantizar que la imagen a la que vincula se muestre tal como está. Eso significa que solo se vinculará la imagen, no toda la interfaz de GitHub para ese archivo respectivo. Vea este comentario para más detalles.
Vea un ejemplo: https://raw.github.com/altercation/solarized/master/README.md
true
Si usa SVG, también deberá configurar el atributo sanitize en : ?raw=true&sanitize=true
. (Gracias @EliSherer)
Además, la documentación sobre enlaces relativos en archivos README: https://help.github.com/articles/relative-links-in-readmes
Y, por supuesto, los documentos de rebajas: http://daringfireball.net/projects/markdown/syntax
Además, si creas una nueva rama screenshots
para almacenar las imágenes puedes evitar que estén en el master
árbol de trabajo.
Luego puedes incrustarlos usando:
![Alt text](/../<branch name>/path/to/image.png?raw=true "Optional Title")
Aunque ya hay una respuesta aceptada, me gustaría agregar otra forma de cargar imágenes en el archivo Léame en GitHub.
- Necesitas crear un problema en tu repositorio.
- Arrastra y suelta en el área de comentarios tu imagen.
- Después de generar el enlace para la imagen, insértelo en su archivo Léame.
Más detalles los puedes encontrar aquí
Descubrí que la ruta a la imagen en mi repositorio no era suficiente, tuve que vincularla a la imagen en el raw.github.com
subdominio.
formato de URLhttps://raw.github.com/{USERNAME}/{REPOSITORY}/{BRANCH}/{PATH}
Ejemplo de rebajas![Settings Window](https://raw.github.com/ryanmaxwell/iArrived/master/Screenshots/Settings.png)