¿Para que sirve? Sirve para tener un wiki sin necesidad de un servidor externo, guardando los archivos en forma de texto plano. La ventaja es que la documentación del proyecto se mantiene en una carpeta junto con el código, en una forma fácil de editar y buscar. El formato que usa es Markdown, que es lo suficientemente amigable y legible para mantener los archivos de texto sin necesidad del wiki.
Pueden encontrar el código en GitHub: https://github.com/dfernandez79/microwiki
Todavía esta en desarrollo, pero la funcionalidad básica de ver y editar esta disponible. Hay muchas cosas por hacer que voy a ir agregando cuando tenga tiempo, al menos la siguientes características van a estar terminadas para el "release 1.0":
- Búsqueda de texto rápida (quizás usando Lucene). Mi objetivo es que browsear y buscar sea rápido, de lo contrario no le veo mucha ventaja sobre utilizar archivos Word u HTML :)
- Paquete binario fácil de usar, la idea es que el típico caso de uso sea hacer checkout de los archivos fuentes e iniciar el wiki (ya sea por un comando o un icono) con cero configuración (por default voy a hacer que tome el subdirectorio docs del directorio actual).
- Modo solo lectura (lo veo útil para integrar con Hudson u algún otro servidor de CI)
Otras cosas que me gustaría agregar a futuro son:
- Soporte para LaTeX probablemente usando http://www.mathjax.org/.
- Soporte para renderizar grafos de GraphViz directamente (la idea seria que los links a gráficos usando la notación  de Markdown se muestren directamente como PNG).
Si tienen interés en chusmear el código fuente, las herramientas que use son:
- Groovy
- Gradle (una buena alternativa a Maven)
- SpockFramework para los tests (les recomiendo mucho este framework, incluso para proyectos Java)
- Jetty
- PegDownParser para parsear el texto en formato Markdown
0 comentarios:
Publicar un comentario