It's not the same without you

Join the community to find out what other Atlassian users are discussing, debating and creating.

Atlassian Community Hero Image Collage

Make READMEs of subfolders also render

Stephen Barr Aug 30, 2011

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.

1 answer

1 vote
Nic Brough [Adaptavist] Community Leader Aug 30, 2011

I'm sorry, I don't understand the question, could you explain further?

A page is a page, they don't "render" differently because of their position in the tree. If you're talking about rendering the content of attached files as though they are wiki pages, you can use macros to display part or all of them on a page, or simply import them as pages.

Stephen Barr Aug 30, 2011

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.

Nic Brough [Adaptavist] Community Leader Aug 30, 2011

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

John Martin Mar 08, 2018

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.

Like Josiah Eubank likes this

Suggest an answer

Log in or Sign up to answer
This widget could not be displayed.
This widget could not be displayed.
Community showcase
Published in Bitbucket Pipelines

Building a Bitbucket Pipe as a casual coder

...ipe.sh :  #!/bin/bash source "$(dirname "$0")/common.sh" enable_debug extra_args="" if [[ "${DEBUG}" == "true" ]]; then extra_args="--verbose" fi # mandatory variables R...

3,314 views 1 22
Read article

Community Events

Connect with like-minded Atlassian users at free events near you!

Find an event

Connect with like-minded Atlassian users at free events near you!

Unfortunately there are no Community Events near you at the moment.

Host an event

You're one step closer to meeting fellow Atlassian users at your local event. Learn more about Community Events

Events near you