Atributos de un módulo
Contenido del curso
Luis Enrique Hernandez Navarro
Bulmaro Arellano Navarrete
Milton Mazzarri
ProfesorPara qué es necesario usar markdown en la documentación? de la poca documentación que he visto ninguna usa ese formato
Hola, Pues así que digamos estrictamente necesario, pues no lo es. Como bien dices puedes documentar sin usar el markdown. No se cuales sean tus fuentes de documentación pero si revisas Github y MDN sí que notarás el uso del markdown.
Si deseas que tu documentación se aprecie bien en HTML, ePub o dentro de IEx debes seguir el formato Markdown. Herramientas como ex_doc, el cual te ayuda a exportar tu documentación a HTML o ePub, interpreta Markdown. Acá también puedes encontrar mayor información acerca de cómo escribir la documentación en Elixir https://hexdocs.pm/elixir/writing-documentation.html
