Con GitHub Pages, puedes mostrar tu trabajo y contar la historia de tus contribuciones a través de una página web única.
Utilizando tu archivo README.md, puedes generar fácilmente un sitio web simple de una sola página. Esta ubicación puede ser accedida con solo hacer clic en un enlace y además se le asignará un dominio personalizado para su identificación.
Tu perfil README.md es la perfecta manera de exponer lo que has hecho para los demás de forma concisa pero detallada; desde menciones en línea hasta proyectos a los que hayas contribuido o imágenes relevantes relacionadas con tu trabajo. Puedes incluir imágenes y enlaces a los proyectos en los que hayas trabajado, menciones y otras colaboraciones en las que hayas participado.
Tu archivo README debe ser visualmente atractivo y, al mismo tiempo, transmitir información de manera organizada.
Usar páginas de GitHub para crear tu sitio web de una página es completamente gratuito. Esto significa que puede tener una presencia en línea de aspecto profesional sin tener que gastar dinero en alojamiento o registro de dominios.
Al incluir proyectos en tu README.md, asegúrate de incluir una descripción concisa de lo que trata el proyecto, el problema que aborda y tus opciones de diseño. De esta manera, incluso aquellos sin experiencia técnica pueden ponerse al día rápidamente en la comprensión del proyecto y tus habilidades.
Creación de un archivo README.md
Si no has creado un README.md, no te preocupes, lo puedes creas simplemente siguiendo estos pasos:
Asegúrate de haber iniciado sesión en tu cuenta de GitHub.
Genera un nuevo repositorio con el mismo nombre que tu nombre de usuario de GitHub.
Por ejemplo, si tu nombre de usuario es “shakira”, el nombre de tu repositorio debe ser “shakira”.Seleccione “Público” para la visibilidad del repositorio.
Marque la casilla “Inicializar este repositorio con un archivo README”.
Haga clic en el botón “Crear repositorio”.
Abra el archivo README.md que se creó en tu repositorio.
Edita el contenido del archivo de README.md para incluir información sobre usted, como tu nombre, una breve biografía, tus habilidades y cualquier proyecto en el que haya trabajado o en el que esté trabajando actualmente. También puedes agregar imágenes, enlaces y otros formatos para que tu perfil se destaque.
Cuando hayas terminado de editar tu archivo README.md, desplácese hacia abajo hasta la parte inferior de la página y haga clic en el botón “Confirmar cambios” para guardar tus cambios.
Regrese a tu página de perfil de GitHub, y ahora debería ver tu archivo de README.md personalizado en la parte superior de tu perfil.
Aquí hay un ejemplo, puedes encontrar el script Markdown aquí:
Aquí tienes otros ejemplos de README.md para tu inspiración:
Ya con tu README.md listo, puedes generar una página estática, usando GitHub Pages.
Implementar tu archivo README.md en GitHub Pages
Ve a tu repositorio existente en GitHub.
Haga clic en la pestaña “Configuración”.
Desplázate hacia abajo hasta la sección “Páginas de GitHub”.
En “Fuente”, selecciona la rama que deseas utilizar para tu sitio de Páginas de GitHub. Puede ser la rama principal, una rama de lanzamiento específica o cualquier otra rama del repositorio.
Si deseas utilizar un dominio personalizado para tu sitio de Páginas de GitHub, agrégalo en el campo “Dominio personalizado”. De lo contrario, déjelo en blanco.
Haga clic en “Guardar” para guardar los cambios.
Espera unos minutos para que GitHub cree y publique tu sitio de GitHub Pages. Una vez hecho esto, puede acceder a tu sitio en
https://nombre-de-usuario.github.io/nombre-repositorio
.
Aquí hay un ejemplo del archivo de README.md de Markdown servido como una página estática de GitHub, que apunta a un dominio personalizado:
Resumiendo, usar un archivo README.md es una excelente manera de contar tu historia y hacerte visible para el resto de la comunidad. Gracias a las facilidades de GitHub Pages, se puede publicar un sitio web completo con sólo un par de clicks, proporcionando así toda la información necesaria para que los demás descubran todo lo que has hecho. Esta es una gran oportunidad para mostrar tu trabajo y abrir la puerta a nuevas colaboraciones y oportunidades.
¿Listos para compartir tu perfil con el mundo?
¡Implementar tu README.md en GitHub Pages es rápido y fácil! Sigue los pasos anteriores y dé el primer paso para llegar a un público más amplio. Pruébalo y ve lo fácil que es hacer que tu trabajo sea accesible para cualquier persona, en cualquier lugar.
Comparte una foto de tu README.md en los comentarios ✨
Top comments (1)
Excelente post 👍, dejo por aquí mi perfil de github, por si le sirve a alguien de inspiración github.com/erikgiovani