Has tu README realmente útil
Muchas veces, el readme se vuelve un poco tedioso, y en ocasiones he preferido usar y abusar de scripts bash, para automatizar procesos, sin embargo, a veces puede resultar un poco difícil mantener ambas cosas, sobre todo en proyectos donde el cambio está a la orden del día, entonces, me encontré con una herramienta que ayuda a convertir los files markdown en obras maestras, muy similar a como usaríamos un Jupyter notebook!
manos a la obra,
La herramienta se llama runme, y básicamente tiene 4 modos de uso:
Con tu editor, por ahora solo con Vscode.
Vía terminal, donde puedes directamente ejecutar un comando de tu README (ya lo veremos!)
Vía terminal pero abriendo un servidor web, que “oh sorpresa”, es un Vscode corriendo en tu navegador.
Vía extensión web.
Veamos un ejemplo
Usando la extensión de Vscode: Runme DevOps Notebooks
Al presionar allí empezarás a ver la magia
Notarás que al acercar el mouse a una celda (sí, cada sección se llama celda como en los Jupyter notebooks)
En nuestro caso, vamos a empezar con algo sencillo, escribiremos el comando
uname -a
Y al ejecutar veremos como la salida de la terminal queda directamente en nuestro README
Veamos todo junto con un ejemplo más grande como se ejecuta
Usando su extensión
Sigue las instrucciones para instalarla [aquí], y si vas al repositorio donde tengo el código del ejemplo anterior,
https://github.com/jairoFernandez/articles/tree/main/readme-powers
Verás un botón que te dará un link de esta forma:
Esto abrirá tu vscode y te permitirá ejecutar el Readme.
Top comments (0)