Can any .md file be set to autodisplay in a github repo the way that a README file does?

If I render my .Rmd output as a github_document it saves as an .md file. I would like this .md file to automatically display its content in github the way that a README.md file does. This would highlight the actual output of my analysis, but I am unsure of how to make .md files autodisplay when they are not README files.

Any .md can be displayed on GITHUB. Not just README.md . Only the extension matters, and the markdown flavor should be GFM which github_document converts to.

Did you try already to see how it looks on github ?

Oh I see, you mean that Github gives a preview by default in a repo folder.

In that case, I think it works with filename indeed . It is a special file considered by Github

This topic was automatically closed 21 days after the last reply. New replies are no longer allowed.

If you have a query related to it or one of the replies, start a new topic and refer back with a link.

Take this example:

The README.md is on full display by default.

The drinks_eda.md is not on display until the file is clicked.