🖖 Inicio

SERVICIOS

Salir

nochedía

Añadiendo shields.io en tu README (o donde quieras)

100 palabras
1 minutos
February 12, 2020
blogjavascript

Para incluir badges que informen de la versión npm de tu paquete (por ejemplo) sólo necesitas introducir una imagen con una url específica

Shields.io

Para la gestión de librerías (paquetes) una de las cosas que hay que preparar (y cuanto más tiempo dediques a ello, mejor) es a la documentación

Y la documentación mínima es la del README, que al menos para github sirve como casi-página principal en cuanto miras la página en concreto (del paquete)

Por ejemplo si vas a uno de los themes de kuworking, por ejemplo este starter, lo que ves (fuera del mapa de archivos) es lo que tienes en el archivo README.md, donde el .md se refiere a que está en formato markdown

Bien

Pues una de las cosas más sencillas de hacer es añadir información relevante en forma de label

Como por ejemplo, la versión que consta en el registro npm

Y cómo hacerlo?

Con shields.io, que su página principal tiene una ristra de categorías para mostrar desde licencias hasta tamaños, o incluso el estado de las dependencias

Es clicar una categoría y ya tienes todos los ejemplos para esa categoría

Y para utilizarlos?

Abajo tienes las instrucciones

js
https://img.shields.io/badge/<LABEL>-<MESSAGE>-<COLOR>

Y sólo falta sustituir el label, message y color

Lo cual para la versión del starter se traduciría en

js
![npm](https://img.shields.io/npm/v/kuworking-theme-affiliate?style=flat-square)

El formato, si no lo tienes claro, puedes explorarlo aquí

Listos!

Qué tal la entrada?
👌 Bien 🙌🙌
👍 Bien, pero algunas cosas podrían explicarse mejor 😬
🤷‍♂️ Da por sentadas demasiadas cosas 😒
🤷‍♂️ A ver, hay poca chicha 😬
🤷‍♂️ Los ejemplos no son muy claros 🙇‍♂️
🤷‍♂️ No se entiende, está mal escrito 👎
✍️ Hay errores, revísalo en cuanto puedas 🙏

Newsletter de kuworking, un correo de tanto en cuanto

Quizá te interese

Privacidad
by kuworking.com
[ 2020 >> kuworking ]