GitHub README.html

Question

我有一个项目的丰富文档,我想开源(通过github).

问题是github README不支持.html文件.

我尝试html2text了绝对可怕的结果.

有没有一种快速简单的方法将naturalDocs(或任何HTML文档)类型输出转换为git自述文件？

多谢你们.

Answer 1

您可以通过以下方法之一将其"返回"转换为Markdown:

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

祝好运

Answer 2

您可以使用GitHub页面发布您的文档,并使用RDoc或Markdown格式编写一个简短信息,其中包含指向README文件中的链接.