Añadir imágenes a README.md en GitHub
Recientemente me uní a GitHub. Fui anfitrión de algunos proyectos allí.
Necesito incluir algunas imágenes en mi archivo README. No se como hacer eso.
Busqué sobre esto, pero todo lo que obtuve fueron algunos enlaces que me dicen que "aloje imágenes en la web y especifique la ruta de la imagen en README.md file".
¿Hay alguna manera de hacer esto sin alojar las imágenes en cualquier servicio de alojamiento web de terceros?
21 answers
Prueba este markdown:
![alt text](http://url/to/img.png)
Creo que puedes enlazar directamente a la versión raw de una imagen si está almacenada en tu repositorio. es decir,
![alt text](https://raw.githubusercontent.com/username/projectname/branch/path/to/img.png)
Editar: acaba de notar comentario enlace al artículo que sugiere el uso de gh-pages. Además, los enlaces relativos pueden ser una mejor idea que las URL absolutas que publiqué anteriormente.
Warning: date(): Invalid date.timezone value 'Europe/Kyiv', we selected the timezone 'UTC' for now. in /var/www/agent_stack/data/www/ajaxhispano.com/template/agent.layouts/content.php on line 61
2017-04-24 08:40:22
También puedes usar rutas relativas como
![Alt text](relative/path/to/img.jpg?raw=true "Title")
Warning: date(): Invalid date.timezone value 'Europe/Kyiv', we selected the timezone 'UTC' for now. in /var/www/agent_stack/data/www/ajaxhispano.com/template/agent.layouts/content.php on line 61
2017-08-30 01:25:13
- Puede crear un nuevo Problema
- subir (arrastrar y soltar) imágenes a la misma
- Copie la URL de las imágenes y péguela en su README.md archivo.
Aquí hay un video detallado de YouTube que explica esto en detalle:
Warning: date(): Invalid date.timezone value 'Europe/Kyiv', we selected the timezone 'UTC' for now. in /var/www/agent_stack/data/www/ajaxhispano.com/template/agent.layouts/content.php on line 61
2018-09-18 19:18:58
También puede agregar imágenes con etiquetas HTML simples :
<p align="center">
<img src="your_relative_path_here" width="350" title="hover text">
<img src="your_relative_path_here_number_2_large_name" width="350" alt="accessibility text">
</p>
Warning: date(): Invalid date.timezone value 'Europe/Kyiv', we selected the timezone 'UTC' for now. in /var/www/agent_stack/data/www/ajaxhispano.com/template/agent.layouts/content.php on line 61
2018-06-29 11:15:50
Es mucho más simple que eso.
Simplemente sube tu imagen a la raíz del repositorio, y enlaza al nombre del archivo sin ninguna ruta, así:
![Screenshot](screenshot.png)
Muchas de las soluciones publicadas son incompletas o no a mi gusto.
- Una CDN externa como imgur añade otra herramienta a la cadena. Meh.
- Crear un problema ficticio en el gestor de problemas es un truco. Crea desorden y confunde a los usuarios. Es un dolor migrar esta solución a una bifurcación, o fuera de GitHub.
- El uso de la rama gh-pages hace que las URL sean frágiles. Otra persona que trabaja en el proyecto mantener la gh-page puede no saber algo externo depende de la ruta a estas imágenes. La rama gh-pages tiene un comportamiento particular en GitHub que no es necesario para alojar imágenes CDN.
- El seguimiento de activos en el control de versiones es algo bueno. A medida que un proyecto crece y cambia, es una forma más sostenible de administrar y rastrear los cambios de varios usuarios.
- Si una imagen se aplica a una revisión específica del software, puede ser preferible vincular una imagen inmutable. De esa manera, si la imagen se actualiza más tarde para reflejar los cambios en el software, cualquier persona que lea el readme de esa revisión encontrará la imagen correcta.
Mi solución preferida, inspirada en esta esencia , es usar una rama assets con permalinks a revisiones específicas .
git checkout --orphan assets
git reset --hard
cp /path/to/cat.png .
git add .
git commit -m 'Added cat picture'
git push -u origin assets
git rev-parse HEAD # Print the SHA, which is needed below.
Construir un "enlace permanente" a esta revisión de la imagen, y envolverlo en Markdown:
![Cat](https://raw.githubusercontent.com/{user}/{repo}/{sha}/cat.png)
Por ejemplo
![Cat](https://raw.githubusercontent.com/paulmelnikow/zsh-startup-timer/3923c60fc66d4223ccf063d169ccf2ff167b1270/cat.png)
Para mostrar siempre la última imagen en la rama assets, use assets
en lugar del sha:
![Cat](https://raw.githubusercontent.com/{user}/{repo}/assets/cat.png)
Warning: date(): Invalid date.timezone value 'Europe/Kyiv', we selected the timezone 'UTC' for now. in /var/www/agent_stack/data/www/ajaxhispano.com/template/agent.layouts/content.php on line 61
2017-03-08 17:13:28
Confirma tu imagen ( imagen.png ) en una carpeta ( myFolder ) y agregue la siguiente línea en su README.md :
![Optional Text](../master/myFolder/image.png)
Warning: date(): Invalid date.timezone value 'Europe/Kyiv', we selected the timezone 'UTC' for now. in /var/www/agent_stack/data/www/ajaxhispano.com/template/agent.layouts/content.php on line 61
2017-07-18 12:56:37
Sintaxis básica
![myimage-alt-tag](url-to-image)
Aquí:
- my-image-alt-tag : texto que se mostrará si la imagen no se muestra.
- url-to-image: sea cual sea tu recurso de imagen. URI de la imagen
Ejemplo:
![stack Overflow](http://lmsotfy.com/so.png)
Esto se verá como lo siguiente:
Warning: date(): Invalid date.timezone value 'Europe/Kyiv', we selected the timezone 'UTC' for now. in /var/www/agent_stack/data/www/ajaxhispano.com/template/agent.layouts/content.php on line 61
2016-01-21 16:09:00
- Crear un problema con respecto a la adición de imágenes
- Añadir la imagen por arrastrar y soltar o por el selector de archivos
Luego copie la fuente de la imagen
Ahora agregue
![alt tag](http://url/to/img.png)
a su README.md archivo
Hecho!
Alternativamente, puede usar algún sitio de alojamiento de imágenes como imgur
y obtener su url y agregarlo en su README.md archivo o puede utilizar algunos archivos estáticos de alojamiento también.
Warning: date(): Invalid date.timezone value 'Europe/Kyiv', we selected the timezone 'UTC' for now. in /var/www/agent_stack/data/www/ajaxhispano.com/template/agent.layouts/content.php on line 61
2016-10-12 19:12:29
Simplemente agregue una etiqueta <img>
a su README.md con src relativo a su repositorio. Si no está utilizando src relativo, asegúrese de que el servidor sea compatible con CORS.
Funciona porque GitHub admite html en línea
<img src="/docs/logo.png" alt="My cool logo"/>
# My cool project and above is the logo of it
Observe aquí
Warning: date(): Invalid date.timezone value 'Europe/Kyiv', we selected the timezone 'UTC' for now. in /var/www/agent_stack/data/www/ajaxhispano.com/template/agent.layouts/content.php on line 61
2018-07-08 17:46:09
Necesito incluir algunas imágenes en mi archivo README. No sé cómo conseguirlo.
He creado un pequeño asistente que te permite crear y personalizar galerías de imágenes simples para el readme de tu repositorio GitHub: Ver ReadmeGalleryCreatorForGitHub.
El asistente aprovecha el hecho de que GitHub permite que las etiquetas img aparezcan en README.md
. Además, el asistente hace uso del popular truco de subir imágenes a GitHub arrastrándolas en el problema área (como ya se mencionó en una de las respuestas en este hilo).
Warning: date(): Invalid date.timezone value 'Europe/Kyiv', we selected the timezone 'UTC' for now. in /var/www/agent_stack/data/www/ajaxhispano.com/template/agent.layouts/content.php on line 61
2017-05-11 13:16:42
En mi caso utilizo imgur y uso el enlace directo de esta manera.
![img](http://i.imgur.com/yourfilename.png)
Warning: date(): Invalid date.timezone value 'Europe/Kyiv', we selected the timezone 'UTC' for now. in /var/www/agent_stack/data/www/ajaxhispano.com/template/agent.layouts/content.php on line 61
2016-12-13 02:00:44
Normalmente alojo la imagen en el sitio, esto puede enlazar a cualquier imagen alojada. Pon esto en el readme. Funciona para archivos .rst
, no estoy seguro acerca de .md
.. image:: https://url/path/to/image
:height: 100px
:width: 200 px
:scale: 50 %
Warning: date(): Invalid date.timezone value 'Europe/Kyiv', we selected the timezone 'UTC' for now. in /var/www/agent_stack/data/www/ajaxhispano.com/template/agent.layouts/content.php on line 61
2015-05-12 17:15:56
He resuelto este problema. Solo necesita referirse al archivo readme de otra persona.
Al principio, ¡debes subir un archivo de imagen a la biblioteca de código de github ! A continuación, referencia directa a la dirección del archivo de imagen .
Warning: date(): Invalid date.timezone value 'Europe/Kyiv', we selected the timezone 'UTC' for now. in /var/www/agent_stack/data/www/ajaxhispano.com/template/agent.layouts/content.php on line 61
2016-07-01 07:44:18
Puedes enlazar a imágenes en tu proyecto desde README.md (o externamente) usando el enlace CDN de github alternativo.
La URL se verá así:
https://cdn.rawgit.com/<USER>/<REPO>/<BRANCH>/<PATH>/<TO>/<FILE>
Tengo una imagen SVG en mi proyecto, y cuando hago referencia a ella en la documentación de mi proyecto Python, no se renderiza.
Project link
Aquí está el enlace del proyecto al archivo (no se representa como un imagen):
Https://github.com/jongracecox/anybadge/blob/master/examples/awesomeness.svg
Ejemplo de imagen incrustada:
Raw link
Aquí está el enlace SIN PROCESAR al archivo (todavía no se renderiza como una imagen):
Https://raw.githubusercontent.com/jongracecox/anybadge/master/examples/awesomeness.svg
Ejemplo de imagen incrustada:
Enlace CDN
Usando el enlace CDN, puedo enlazar al archivo usando (renders como un imagen):
Https://cdn.rawgit.com/jongracecox/anybadge/master/examples/awesomeness.svg
Ejemplo de imagen incrustada:
Así es como puedo usar imágenes de mi proyecto tanto en mi archivo README.md
como en mi proyecto PyPI reStructredText doucmentation (aquí)
Warning: date(): Invalid date.timezone value 'Europe/Kyiv', we selected the timezone 'UTC' for now. in /var/www/agent_stack/data/www/ajaxhispano.com/template/agent.layouts/content.php on line 61
2018-02-10 16:57:13
En mi caso quería mostrar una pantalla de impresión en Github
pero también en NPM
. Aunque usar la ruta relativa estaba funcionando dentro de Github
, no estaba funcionando fuera de ella. Básicamente, incluso si empujé mi proyecto a NPM
también (que simplemente usa el mismo readme.md
, la imagen nunca se mostraba.
Probé algunas maneras, al final esto es lo que funcionó para mí:
![Preview](https://raw.githubusercontent.com/username/project/master/image-path/image.png)
Ahora veo mi imagen correctamente en NPM
o en cualquier otro lugar que podía publicar mi paquete.
Warning: date(): Invalid date.timezone value 'Europe/Kyiv', we selected the timezone 'UTC' for now. in /var/www/agent_stack/data/www/ajaxhispano.com/template/agent.layouts/content.php on line 61
2016-07-27 23:31:19
En caso de que necesite cargar algunas imágenes para la documentación, un buen enfoque es usar git-lfs. Suponiendo que ha instalado el git-lfs siga estos pasos:
-
Inicializa git lfs para cada tipo de imagen:
git lfs *.png git lfs *.svg git lfs *.gif git lfs *.jpg git lfs *.jpeg
-
Crear una carpeta que se utilizará como ubicación de la imagen por ejemplo.
doc
. En sistemas basados en GNU / Linux y Unix esto se puede hacer a través de:cd project_folder mkdir doc git add doc
Copie y pegue cualquier imagen en la carpeta doc. Luego añadirlos a través de
git add
comando.Comprométete y empuja.
-
Las imágenes están disponibles públicamente en la siguiente url:
Https://media.githubusercontent.com/media / ^github_username^/^repo^/^branch^ / ^image_location en el repo^
Donde:
* ^github_username^
es el nombre de usuario en github (lo puedes encontrar en la página de perfil)
* ^repo_name^
es el nombre del repositorio
* ^branch^
es la rama del repositorio donde se carga la imagen
* ^image_location in the repo^
es la ubicación que incluye la carpeta en la que se almacena la imagen.
También puedes subir la imagen primero, luego visitar la ubicación en la página de github de tus proyectos y navegar hasta encontrar la imagen, luego presionar el botón download
y luego copiar y pegar la url de la barra de direcciones del navegador.
Mira esto de mi proyecto como referencia.
Entonces puedes usar la url para incluirlos usando la sintaxis de markdown mencionada anteriormente:
![some alternate text that describes the image](^github generated url from git lfs^)
Eg: Supongamos que usamos esto photo Entonces puedes usar la sintaxis markdown:
![In what order to compile the files](https://media.githubusercontent.com/media/pc-magas/myFirstEnclave/master/doc/SGX%20Compile%20workflow.png)
Warning: date(): Invalid date.timezone value 'Europe/Kyiv', we selected the timezone 'UTC' for now. in /var/www/agent_stack/data/www/ajaxhispano.com/template/agent.layouts/content.php on line 61
2017-12-01 11:47:35
Solo estoy extendiendo o agregando un ejemplo a la respuesta ya aceptada.
Una vez que hayas puesto la imagen en tu repositorio de Github.
Entonces:
- Abre el repositorio Github correspondiente en tu navegador.
- Navegue hasta el archivo de imagen de destino y luego abra la imagen en una nueva pestaña.
- Copie la url
- Y finalmente insertar la url al siguiente patrón
![alt text](https://raw.githubusercontent.com/username/projectname/branch/path/to/img.png)
En mi caso es
![In a single picture](https://raw.githubusercontent.com/shadmazumder/Xcode/master/InOnePicture.png)
Donde
-
shadmazumder
es miusername
-
Xcode
es elprojectname
-
master
es elbranch
-
InOnePicture.png
esimage
, En mi casoInOnePicture.png
está en el directorio raíz.
Warning: date(): Invalid date.timezone value 'Europe/Kyiv', we selected the timezone 'UTC' for now. in /var/www/agent_stack/data/www/ajaxhispano.com/template/agent.layouts/content.php on line 61
2018-08-29 19:40:30
ÚLTIMO
Las wikis pueden mostrar imágenes PNG, JPEG o GIF
Ahora puedes usar:
[[https://github.com/username/repository/blob/master/img/octocat.png|alt=octocat]]
O
Siga estos pasos:
En GitHub, navega a la página principal del repositorio.
Bajo el nombre de tu repositorio, haz clic en Wiki.
Usando la barra lateral del wiki, navega a la página que deseas cambiar y luego haz clic en Editar.
En la barra de herramientas del wiki, haga clic en Image .
- En el cuadro de diálogo "Insertar imagen", escriba la URL de la imagen y el texto alternativo (que utilizan los motores de búsqueda y los lectores de pantalla).
- Haga clic en Aceptar.
Refiérase a los documentos.
Warning: date(): Invalid date.timezone value 'Europe/Kyiv', we selected the timezone 'UTC' for now. in /var/www/agent_stack/data/www/ajaxhispano.com/template/agent.layouts/content.php on line 61
2018-01-23 09:01:07
¡ESTO FUNCIONA!!
Tenga cuidado con su nombre de archivo en mayúsculas en la etiqueta y ponga el archivo PNG inroot, y enlace al nombre del archivo sin ninguna ruta:
![Screenshot](screenshot.png)
Warning: date(): Invalid date.timezone value 'Europe/Kyiv', we selected the timezone 'UTC' for now. in /var/www/agent_stack/data/www/ajaxhispano.com/template/agent.layouts/content.php on line 61
2018-08-14 18:10:16
Podemos hacer esto, simplemente,
- crear un nuevo número en GitHub
- arrastrar y soltar imágenes en el cuerpo
div
de Emisión
Después de unos segundos, se generará un enlace. Ahora, copie el enlace o la URL de la imagen y úsela en cualquier plataforma compatible.
Warning: date(): Invalid date.timezone value 'Europe/Kyiv', we selected the timezone 'UTC' for now. in /var/www/agent_stack/data/www/ajaxhispano.com/template/agent.layouts/content.php on line 61
2018-08-05 14:07:49