Question

我的应用程序的文档是一组HTML文件。这些HTML文件是我的git repo的一部分。如果我把这个项目放在github上，那么人们是否能够将HTML文档文件视为呈现HTML而不是原始HTML？

Answer 1

简短的回答是否定的，github不会呈现HTML文档/自述文件。

答案很长： Github使用此code来呈现任何README文件。从文档中可以看出，它只支持以下丰富的文本格式：

.markdown，.mdown，.md
.textile
.rdoc
。组织
.creole
.mediawiki
.rst
.asciidoc
.POD

尽管有许多HTML to * MARKUP_LANG *转换器可能在某种程度上对您有帮助。

您还可以考虑使用Github Pages，它可以让您完全控制页面的HTML / CSS / J。

Answer 2

AFAIK，Github文档处于降价状态。并且HTML文件作为repo的一部分显示为原始HTML。

或者，您可以使用Github pages发布文档。

GitHub支持各种格式，

支持以下标记。如果您希望运行库，则需要列出的依赖项。

.markdown, .mdown, .md -- gem install redcarpet (https://github.com/vmg/redcarpet)
.textile -- gem install RedCloth
.rdoc -- gem install rdoc -v 3.6.1
.org -- gem install org-ruby
.creole -- gem install creole
.mediawiki -- gem install wikicloth
.rst -- easy_install docutils
.asciidoc -- brew install asciidoc
.pod -- Pod::Simple::HTML comes with Perl >= 5.10. Lower versions should install Pod::Simple from CPAN.

HTML文件形式的文档是否适用于github？

2 个答案: