Cómo personalizar tu perfil GitHub con un archivo README

#github #readme #markdown #customize

GitHub lanzó recientemente una función que permite a los usuarios crear un archivo README a nivel de perfil para mostrarlo de manera destacada en tu perfil de GitHub sustituyendo a la pantalla tradicional con tus repositorios.

En este artículo te explicaré cómo acceder a esta nueva función. También compartiré algunos perfiles curiosos de GitHub que he visto en otros usuarios que te podrán dar ideas para generar tu propio perfil personalizado 😜.

Pasos para crear tu perfil personalizado en GitHub

¿Has probado alguna vez a crear un repositorio en GitHub con tu mismo nombre de usuario? Por ejemplo, mi usuario en GitHub es alextomas80, entonces, para mostrarte ésta nueva funcionalidad voy a crearme un nuevo repositorio que se llame así: alextomas80.

Crear nuevo repositorio

Primero debemos acceder a la url para crear nuevo repositorio, desde aquí.

Luego rellenamos el campo Repository name, quedando así:

¡Eh! ¡Espera! ¿Qué es eso? Te habrás dado cuenta del aviso que te ha aparecido, ¿no?

You found a secret! alextomas80/alextomas80 is a ✨special ✨ repository that you can use to add a README.md to your GitHub profile. Make sure it’s public and initialize it with a README to get started.

¡Premio! GitHub ya te informa de esa nueva funcionalidad especial que te comentaba. Ahora sólo tenemos que editar nuestro README.md.

Ver nuestro perfil personalizado con README.md

Si has dejado activada la opción Add a README file ya tendrás tu propio fichero, que únicamente tendremos que editar. En el caso de que no lo hayas activado, tendrás que crear el fichero. Fácil.

Una vez creado el nuevo repo especial te redireccionará a su url, en mi caso me lleva a https://github.com/alextomas80/alextomas80

Aquí vemos varias cosas:

Nuestro README.md de ejemplo auto generado al crear el repo.
Un aviso indicándonos, una vez más, que es un repo especial (alextomas80/alextomas80 is a special repository. Its README.md will appear on your public profile! Send feedback) dónde nos invita a editar nuestro README o bien mirar como ha quedado nuestro perfil.

Antes de crear el repositorio especial mi perfil se veía de la siguiente manera:

Una vez creado el repo especial se ve de la siguiente manera:

Como verás, el contenido del fichero README.md del repo especial lo inserta automáticamente arriba del todo, en mi caso, de momento no es gran cosa ya que hemos usado el README.md por defecto que nos ha generado Github, pero bueno, ¡es un comienzo! 😀

Modificar README.md para darle forma a nuestro perfil

Vale, vamos a darle un poco de vida a nuestro repositorio y le pondremos un poco de información. Accede a tu repo especial y editamos el README.md. Recuerda que es un fichero .md por lo tanto todo lo que soporte la sintaxis Markdown podrás insertar en él.

Así se ve nuestro README.md por defecto.

Y ahora lo vamos a editar un poco a nuestro gusto. El mío de momento lo voy a dejar de la siguiente forma:

Guardamos el README.md creando un commit desde la propia web de Github:

Recuerda que te puedes clonar el repo en tu equipo y trabajar de forma local como seguramente habrás hecho muchas veces. En mi caso, para el ejemplo, lo he hecho todo desde la web.

Y podemos ver por fin el resultado: