GitHub README.html

Question

У меня есть множество документации для проекта, который я хотел бы сделать с открытым исходным кодом (через github).

Проблема в том, что github README не поддерживает файлы .html.

Я пытался html2text с абсолютно ужасными результатами.

Существует ли быстрый и простой способ преобразования вывода типа naturalDocs (или любой другой HTML-документации) в файл git readme?

Спасибо, ребята.

Answer 1

Вы можете преобразовать его «обратно» в Markdown одним из следующих способов:

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

Удачи

Answer 2

Вы можете использовать GitHub Pages для публикации своей документации и записи краткой информации со ссылкой в ​​файл README в формате RDoc или Markdown.