GitHub README.html

Question

Tengo una gran cantidad de documentación para un proyecto que me gustaría hacer de código abierto (a través de github).

El problema es que github README no admite archivos .html.

Probé html2text con absolutamente horribles resultados.

¿Existe una forma rápida y fácil de convertir la escritura de los naturalesDocs (o cualquier documentación html) a un archivo léame git?

Gracias chicos.

Answer 1

Puede usar GitHub Pages para publicar su documentación y escribir una breve información con un enlace a la de su archivo README utilizando el formato RDoc o Markdown.

Answer 2

Se podría convertirlo "atrás" para Markdown a través de uno de los métodos siguientes:

1. http://fvsch.com/code/remarkdown/
2. https://tibastral.github.io/markdownify/
3. http://johnmacfarlane.net/pandoc/try

Buena suerte