GitHub acaba de lanzar una nueva funcionalidad que te permite mostrar un README completamente personalizado en la página de tu perfil. Como estoy seguro que tu también quieres disfrutar de esta nueva característica, te voy a explicar paso a paso lo que debes hacer para conseguir el tuyo.
Puedes seguir el vídeo que hice en directo donde he creado mi README desde cero, dando ideas y añadiendo GitHub Actions para que se actualice automáticamente (o puedes seguir leyendo el artículo si lo prefieres):
{{< youtube id=“1eEnboVooiY” >}}
Crear el repositorio en GitHub con tu nombre de usuario
- Accede a https://github.com/new
- Como
Repository Name
utiliza tu propio nombre de usuario en GitHub. - Una notificación te avisará que vas por buen camino:
{{< img src=“/images/github-mi-readme-01.png” alt=“Un divertido gatito te dirá que el repositorio que vas a crear es especial” align="">}}
- Como bien dice el aviso, ahora tenemos que asegurarnos que:
- Hacemos el repositorio público.
- Lo inicializamos con un archivo
README.md
.
{{< img src=“/images/github-mi-readme-02.png” alt=“Tienes hacer el repositorio público y asegurarte que lo inicializas con un archivo README.md” align="">}}
- Para terminar dale a
Create repository
y ya tendremos listo el repositorio con nuestro archivoREADME.md
. - Ahora sólo nos faltaría darle vida a este fichero usando GitHub Markdown gracias al cuál podremos subir imágenes y formatear el contenido. ¡Recuerda que tienes que pushear los cambios al repositorio para verlo reflejado en tu perfil!
Algunos ejemplos de GitHub READMEs
Monica.dev ha creado el suyo de forma limpia y bonita, que ya ha servido de inspiración para unos cuantos:
I published an article about how to create your own profile-level README on GitHub + shared some of my faves for inspiration: https://t.co/bY1juUWG57
— Monica.dev 👩🏾💻 (@waterproofheart) July 11, 2020
TLDR - Create a new repository with the same name (including casing) as your GitHub username at: https://t.co/jbMOTSKNOx pic.twitter.com/Na1F7QYC28
Sindre Sorhus (@sindresorhus) troleando al personal con un README que nunca deja de cargar…
Really awesome that you can now show a README on your GitHub Profile. I've included a lot of cool stuff in mine: https://t.co/CW65WurVkU
— Sindre Sorhus (@sindresorhus) July 9, 2020
Pouya (@Saadeghi) le ha encontrado otra utilidad diferente a su página de README:
Is this how we suppose use github's readme? pic.twitter.com/XvLvCUC6iD
— Pouya (@Saadeghi) July 9, 2020
Para los nostálgicos del lugar, Ben Balter (@benbalter) ha creado uno inspirado en las antiguas páginas web de Geocities. Marquesinas y un gif de “Under construction”:
Jumping on the GitHub README profile bandwagon with my own GeoCities throwback, complete with working hit counter (best viewed in IE3 or later). https://t.co/4le5H0I6an https://t.co/oMsqKQPAMc pic.twitter.com/koXN9lgkVI
— Ben Balter (@benbalter) July 9, 2020