Usando github gists para mostrar bloques de código

Foto de portrato de Paul Matute

Paul Matute

Publicado el 1 de agosto de 2023

Compartir

Los repositorios de GitHub son excelentes para compartir proyectos completos, pero a veces necesitas una solución más sencilla para compartir pequeños bloques de código. GitHub Gists te permite exactamente esto.

Computadora en un cuarto

Github Gists are great for showing small code snippets. Either just using the site or embeding them into your site, they are a more user-friendly way of sharing code snippets. Embedding into your site can be fairly straightforward, but you might need some special considerations depending on your use case.

Crear un gist

Creat un gist es muy sencillo. Navega a https://gist.github.com e ingresa cualquier codigo que quieras. Si quires incluir varios archivos, solo debes hacer click en 'add file'. Una vez hayas acabado de escribir tu código, asegurate de cambiar la opción de publicación a 'Create public gist'.

Insertarlo en tu sitio

Dependiendo en tu sitio, simplemente puedes usar el código de compartir creado por github como te muestro a continuación.

Pero en otras situaciones es necesario usar <iframe />. Al usar <iframe />, puede ser necesario realizar un cambio. En lugar de usar la URL de src proporcionada por github, se debe eliminar el final .js y reemplazarlo con .pibb.

Solo mostrar un archivo

Para mostrar solo un archivo del gist, hay una pequeña modificación en la URL que se debe realziar. Se debe agregar el siguiente parámetro de búsqueda ?file=<your-file-name>.

¡Y eso sería todo! Es muy simple y se ve bastante bien.

Otros posts

Computadora en un cuarto

Usando github gists para mostrar bloques de código

Los repositorios de GitHub son excelentes para compartir proyectos completos, pero a veces necesitas una solución más sencilla para compartir pequeños bloques de código. GitHub Gists te permite exactamente esto.