How to reference other .md files in README.md

 

I have read the docs but can't figure out how to reference other .md files in the README.md.  I have some .md files in the root and subdirectories (folders) that I want to reference in the README.md for people to read.

I am probably doing something very simple that is wrong.  Please point me in the right direction.

thanks

sb

1 answer

0 vote
Boris Berenberg Community Champion Dec 22, 2014

Are you trying to create links to those files, and then have Bitbucket render those files for you? If so, this syntax should work to create the link: http://daringfireball.net/projects/markdown/syntax#link Though I am not sure how BB will handle it.

Or are you trying to include them to essentially build a README.md out of component files?

Boris,

Thanks for your response. It is the former over the later.  I followed the syntax on the daring fireball website.  But whatever link I use to the subdocs or secondary docs (whatever you want to call them), I get nasty 404 errors saying it can't find my docs (.md files).

any advice on the structure of the URL links would be great.

thanks

scott

Boris Berenberg Community Champion Dec 23, 2014

http://stackoverflow.com/questions/4779582/markdown-and-including-multiple-files I don't think that Markdown itself has support for including other files. My recommendation would be to have the README.md file built using a pre-commit script. There is no limitation on links within Markdown, and all Bitbucket does is render it. Your links should just be the links you see in your browser's url bar when you view the .md file in your repo as a user which has access to it. You can use http://www.markdownviewer.com/ to test your syntax on the fly.

Suggest an answer

Log in or Sign up to answer
How to earn badges on the Atlassian Community

How to earn badges on the Atlassian Community

Badges are a great way to show off community activity, whether you’re a newbie or a Champion.

Learn more
Community showcase
Posted Jun 12, 2018 in Bitbucket

Do you use any Atlassian products for your personal projects?

After spinning my wheels trying to get organized enough to write a book for National Novel Writing Month (NaNoWriMo) I took my affinity for Atlassian products from my work life and decided to tr...

23,506 views 26 12
Join discussion

Atlassian User Groups

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

Find a group

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

Find my local user group

Unfortunately there are no AUG chapters near you at the moment.

Start an AUG

You're one step closer to meeting fellow Atlassian users at your local meet up. Learn more about AUGs

Groups near you