GitHub README.html

Question

오픈 소스를 만들고 싶습니다 (github 통해) 프로젝트에 대한 풍부한 문서가 있습니다.

문제는 github README가 .html 파일을 지원하지 않는다는 것입니다.

나는 html2text을 절대적으로 무시 무시한 결과로 보았습니다.

naturalDocs (또는 모든 HTML 문서) 유형 출력을 git readme로 쉽게 변환 할 수 있습니까?

감사합니다.

Answer 1

GitHub Pages을 사용하여 RDoc 또는 Markdown 형식을 사용하여 README 파일에 설명서를 게시하고 README 파일에있는 링크가있는 간단한 정보를 작성할 수 있습니다.

Answer 2

다음 방법 중 하나를 통해 "뒤로"마크 다운로 변환 할 수 있습니다 :

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

행운