CODEWITHSUNDEEP
gitgithubmarkdown
PriamoRamirez
PriamoRamirez

Reputation: 71

Is it possible to make GitHub render a Markdown within a folder, with a name different than Readme?

I've push some text templates I use, since I usually use my git to show my work, and due to my profession we use a lot of documents, I wanted to share some template in Markdown format.

I understand github automatically render Markdown file with README Name, but is it possible to make github to render a markdown file with a different name.

I've done some search and came out with no result, In advance I apologize if this has being asked to many times.

Thank you

Upvotes: 5

Views: 2724

Answers (1)

Alex Reece
Alex Reece

Reputation: 2026

If your name any file Foo.md, you can go to that file in the repository browse view and it'll render the markdown file.

For example, here's a markdown file from my personal blog: https://github.com/awreece/codearcana/blob/master/content/performance/achieving_maximum_memory_bandwidth.md

Upvotes: 1

Related Questions