¿La documentation en forma de files HTML funciona en github?

La documentation para mi aplicación es un set de files HTML. Estos files HTML son parte de mi git repo. Si pongo este proyecto en github ¿podrán las personas ver los files de la documentation HTML como HTML procesado en lugar de HTML sin formatting?

La respuesta corta es no, github no procesará la documentation HTML / READMEs.

Respuesta larga: Github usa este código para representar cualquier file README. Como puede ver en su documento, solo es compatible con los siguientes formattings de text enriquecido:

  • .markdown, .mdown, .md
  • .textil
  • .rdoc
  • .org
  • .criollo
  • .mediawiki
  • .rst
  • .asciidoc
  • .vaina

Aunque hay muchos convertidores HTML a * MARKUP_LANG * que pueden ayudarlo hasta cierto punto.

También puede considerar usar Github Pages que le otorgará control total sobre HTML / CSS / Js de la página.

AFAIK, la documentation de Github está en rebajas. Y los files HTML como parte de un repo se muestran como HTML sin formatting.

Alternativamente, puede usar las páginas de Github para publicar su documentation.

Existen varios formattings compatibles con GitHub,

Las siguientes marcas son compatibles. Las dependencies enumeradas son obligatorias si desea ejecutar la biblioteca.

.markdown, .mdown, .md -- gem install networkingcarpet (https://github.com/vmg/networkingcarpet) .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.