Home > Software engineering >  In Github when creating github.io profile what the difference of .md .html .rmd files?
In Github when creating github.io profile what the difference of .md .html .rmd files?

Time:11-18

I'm trying to create a github.io profile.

May I know the difference between of .md .html .rmd files?

For example, I see the same file name with different filetypes like Readme.md vs Readme.html XXX.rmd vs XXX.html

CodePudding user response:

github.io (aka Github pages) can create a website from either

  • html with optional css
  • Markdown files (.md and .rmd)
  • A combination of the above

It uses a set of tools called Jekyll and kramdown to translate markdown files into html to be displayed as part of the website.

Markdown files are a file format generally used for producing documentation in github on similar websites, and has a mopre streamlined syntax for that purpose than html. You can try it out at https://stackedit.io

The use of markdown for Github Pages is however completely optional and you may use only html if you wish. You can follow the guide at https://jmcglone.com/guides/github-pages show you how to make a github pages site with html. Stop when you get to the section Using Jekyll with GitHub Pages if you don't wish to incorporate any markdown.

  • Related