Documentar Software con Markdown y MDWiki

Recientemente tuve el requerimiento de crear una web tipo wiki que permita documentar los diversos desarrollos de software, la plataforma y las configuraciones de una empresa. El único requerimiento: Que sea fácil de escribir, de tal manera que el desarrollador/editor no se fastidie haciéndolo.

Mi primera idea: Markdown!:

Markdown es un lenguaje de marcado ligero que trata de conseguir la máxima legibilidad y facilidad de publicación tanto en su forma de entrada como de salida, usando texto plano.

Es así como hallé un excelente proyecto que genera páginas totalmente dinámicas a partir de sencillos documentos .md. Se trata de MDWiki, un excelente proyecto consistente en un solo archivo .html que genera todo el procesamiento del lado del cliente. De modo que quien genera el contenido, solo se debe preocupar por crear el documento .md, dejarlo en el servidor web, y listo!.

Una captura de como se ve el producto final:
mdwiki screenshot

El archivo index.md que lo genera:
index.md file

Publicado por

sansagara

Software and Data Engineer. Tech Passionate. Open Source Advocate.

Deja un comentario

Tu dirección de correo electrónico no será publicada. Los campos obligatorios están marcados con *