Make READMEs of subfolders also render

Question

This is both a question and a suggestion. Is it possible to make marked up README files within subfolders also render, the way that they do at the root folder. This would be nice for larger products, where there are sub folders which necessitate their own README files.

John Martin_xjxfo2 · Answer

I agree. Any README within a directory should be displayed by default the same way it does when you access the top level directory of the repository. Perhaps the configuration could be set at the repository level... on by default.

This could be especially useful for developing content for instructional purposes... each level in the hierarchy provides meta data in the README.md file that can be relevant for accessing child items within the current directory.

Nic Brough -Adaptavist- · Answer

My apologies, I thought you were talking about Confluence.  Please ignore me!

Stephen Barr1 · Answer

On bitbucket, when looking at the source code of a project, if you have a README.rst file at the root of the project, then below the listing of files, the ReStructured Tex will render.

This is documented here: http://confluence.atlassian.com/display/BITBUCKET/Displaying+README+Text+on+your+Bitbucket+Source+Tab

My suggestion is to have this behaviour also apply to subdirectories of the tree. Therefore, if I am browsing myproject/tests and my tests folder has a README.rst file, it should render just the way myproject/README.rst does.