CODEWITHSUNDEEP
github
Ryan
Ryan

Reputation: 6055

Does documentation in the form of HTML files work on github?

The documentation for my application is a set of HTML files. These HTML files are part of my git repo. If I put this project on github will people be able to view the HTML documentation files as rendered HTML rather than raw HTML?

Upvotes: 1

Views: 306

Answers (2)

Ameen
Ameen

Reputation: 318

AFAIK, Github documentation is in markdown. And HTML files as part of a repo display as raw HTML.

Alternatively, you could use Github pages to publish your documentation.

There are the various formats GitHub supports,

The following markups are supported. The dependencies listed are required if you wish to run the library.

.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.

Upvotes: 0

K Z
K Z

Reputation: 30453

The short answer is no, github will not render HTML documentation/READMEs.

Long answer: Github uses this code to render any README files. As you can see from its doc, it only supports the following rich texts formats:

  • .markdown, .mdown, .md
  • .textile
  • .rdoc
  • .org
  • .creole
  • .mediawiki
  • .rst
  • .asciidoc
  • .pod

Although there are many HTML to *MARKUP_LANG* converters that may help you to some degree.

You can also consider using Github Pages which will give you total control over the HTML/CSS/Js of the page.

Upvotes: 1

Related Questions