Código abierto · Markdown · Local First
Kimu
Un visor de Markdown pequeño y simple
Kimu es un proyecto que hice para resolver un problema que creo que es cada vez más frecuente. Trabajando con Agentes, es común empezar a leer, revisar y corregir una tonelada de archivos Markdown locales. Después de un tiempo, empecé a odiar leer los archivos en texto plano (o dentro del IDE) en vez de una página HTML bonita y fácil de recorrer con la vista. Y así nació Kimu.
La motivación de Kimu #
Si prefiere leer sobre qué es lo que hace Kimu, vaya a la sección Pero ¿qué es Kimu?. Esta sección cuenta la historia de cómo nació el proyecto.
Observé que el Agente (¡y yo!) empieza a generar un montón de archivos Markdown que luego tengo que Revisar (el famosillo Human-in-the-Loop). Esto rápidamente se volvió una tarea tediosa que no quería hacer, lo que atribuyo en parte a lo feo que es leer Markdowns en texto plano. Es así que empecé a usar pandoc para transformar los archivos de Markdown a HTML:
pandoc -i input.md -o output.html
El resultado era un archivo HTML simple que podía leer, pero era todavía un poco plano, sin personalidad, así que empecé a usar water.css para darle formato a los archivos. Era mucho mejor, tenía archivos locales que podía leer con una interfaz mucho más agradable... pero aun así no era suficiente:
- Si el Markdown original cambiaba, tenía que regenerar el HTML a mano, y luego recargar la página.
- Si quería agregar nuevas funcionalidades al CSS, tenía que propagarlo a mano a todos mis PCs.
- Para no agregar archivos innecesarios a los proyectos de Git, empecé a agregar una entrada
docs/*.htmla todos mis.gitignore, que a veces se me olvidaba, lo que significaba que un cansadogit add . && git commit -m "update docs" && git pushde fin de día terminaba en un archivo HTML no deseado en el repo.
Claro que el resultado ahora era mejor:


Así que se me ocurrió hacer un pequeño visor de Markdown. Al principio era un mini-proyectito dentro de mi proyecto más grande, Invntry, lo hice de una (oneshot) con un Agente y listo, era simplemente una herramienta rápida.
Mi idea era tener un visor para el proyecto principal en el que estaba trabajando, que pudiera correr fácilmente con un comando como uv run docs/serve.py. El problema fue que rápidamente empecé a agregarle más y más funcionalidades, así que lo moví a su propio repo, le busqué un nombre y seguí agregando cosas. El producto pulido me pareció tan útil, bonito y rápido, que pensé que quizás el mundo (¿¿o quizás el vacío??) se beneficiaría mucho con él. Puedo anunciar con orgullo que tanto a mi papá como a mi polola les gusta la app, quizás eso es suficiente.
Pero ¿qué es Kimu? #
Ok, ya tenemos el porqué: necesitaba leer mis archivos Markdown y quería darme el gusto de una interfaz más bonita en vez de un editor de texto aburrido. Pero ¿qué ES Kimu?
El nombre Kimu #
Si tiene curiosidad por el nombre, no es nada tan serio, necesitaba un nombre provisorio para el repo de GitHub, pero terminó gustándome mucho. Necesitaba algo corto, para poder hacer algo así como kimu docs rápidamente desde la terminal, en vez de kimu-beautiful-simple-and-fast-reader docs. Y Kimu se parece a Kimün, una palabra mapuche que significa conocimiento. ¿Lindo, no?
El logo intentó representar un árbol, estaba pensando algo como que el conocimiento es como las raíces de un árbol que lo mantienen fuerte y de pie. No sé, no es tan profundo, pero creo que el logo quedó suficientemente bonito. Días después, con una búsqueda rápida en Google, encontré Kumu, que creo que es algo así como una base de conocimiento, que también usa como logo un árbol con raíces, con una idea medio digital. ¿El mundo es un pañuelo, supongo?

En fin, estaba buscando una palabra corta con un significado parecido a conocimiento y la encontré.
Funcionalidades #
Ok, ¿y por qué usaría Kimu?, podría preguntar un lector astuto. Bueno, creo que tiene un par de funcionalidades que la hacen una pequeña app muy bonita, las voy a listar y quizás podamos discutirlas:
- Es offline first: Maravilloso, ¿o no? No se necesita conexión a internet para usarla, puede irse al medio del bosque, abrir Kimu y revisar la montaña de texto que generan estos agentes. Se va a sentir fresco y feliz, con sus temas bonitos.
- Es rápida: Pero rápida de verdad. No le da tiempo de procrastinar, de abrir redes sociales, nada: carga al instante. Eso me gusta muchooo. Ni siquiera tiene dependencias, no quise incluir paquetes de NPM por ejemplo. Eso parece ser un riesgo de seguridad hoy en día. El software se vuelve un mutante con mil dependencias, y como la app es tan simple y pequeña, si necesito algo como una librería, el Agente la puede construir. No necesito nada sofisticado, solo algo rápido y que funcione.
- Es segura: ¿Offline, sin dependencias, y no tanto código? Se ve segura. Un lector levemente desconfiado puede pedirle a su Agente favorito que revise el código si quiere (pero si encuentra algo, déjeme un issue por favor).
- Ergonómica: Esta es una de esas funcionalidades que no se notan hasta que se notan, y es que los proyectos de hobby suelen descuidar la ergonomía. Se pueden abrir varias pestañas y personalizar el tamaño de la letra y el ancho de la vista. La app recuerda la posición en cada pestaña y recarga los archivos automáticamente (manteniendo la posición en la página, ¡usé unos trucos sucios para esto!). Me gusta mucho usar la app, nunca estorba, simplemente la abro, la uso para leer y se me olvida que está ahí... bueno, quizás usted, querido lector, se acordará cuando un colega suyo le pregunte qué es esa cosa tan bonita que está mirando.
Hay muchas otras funcionalidades, como los 7 temas que tiene, la tabla de contenidos autogenerada en la barra lateral, la barra lateral redimensionable, soporte para LaTeX y Mermaid, etc. Pero no creo que sean funcionalidades estrella, sino más bien lo que se espera para que esta app pueda llamarse app. Las funcionalidades de arriba son las que creo que lo hacen a uno mirar hacia atrás como en ese meme del novio distraído. Lo voy a describir porque no quiero que esta página se vea anticuada con un meme de 2016: la pareja enojada tiene el texto "Leer Markdown en texto plano" y la mujer distractora tiene "Leer Markdown con Kimu".
Hablando de los temas, me gustaría mostrarle la obra de arte que es el showcase de los temas en el Readme del proyecto:

Déjeme contarle cómo hice este showcase, quizás se inspira en su próximo proyecto: saqué 7 capturas de pantalla en la misma posición pero con temas distintos, y después intenté describirle el efecto a Gemini para que construyera un script rápido en JS que mostrara las imágenes. Lo grabé con OBS, lo edité con DaVinci Resolve para que hiciera un loop perfecto, y finalmente lo transformé a gif usando ffmpeg. Me gusta mucho el efecto, pero lo que más me gustó fue que de la idea al resultado me tomó como 15 minutos, entre Agentes y hacer las conexiones a mano. El efecto es mucho más bonito si clona el proyecto y abre el archivo index.html que enlacé más arriba, y así se puede ver a gloriosos <muchos> FPS, en vez de ese gif comprimido a 15 FPS y lleno de artefactos.
Trabajo futuro #
Creo que Kimu está casi terminado. Si tiene sugerencias, las leeré con gusto, pero me gusta mucho cómo está Kimu ahora.
Algunas cosas en las que he estado pensando, y que probablemente terminaré construyendo, sin ningún orden en particular:
- Instalación más fácil
- Edición de texto en línea, con una barra de herramientas mínima
- Probablemente más fuentes
Y eso es todo.
Gracias por leer.