Use a wiki

When you add a repository to Bitbucket Cloud, you also get a wiki. The wiki is a simple place to keep documents. Some people use it as their project home page. The wiki is a Mercurial/Git repository, so you can clone it and edit it like any other source files  For example, take a look at the TortoiseHg wiki on Bitbucket Cloud.

Want to Improve or Comment on our Wiki Feature?

Our development team reviews issues in our issue tracker to help prioritize new production features. If you want to request functionality or otherwise comment on the Wiki feature, your voice is best heard by filing an issue on the issue tracker. You can view a list of open Wiki issues here or here.

Supported Markup Languages

Bitbucket Cloud wikis support Creole, Markdown, reStructuredText, and Textile syntax. There is special Bitbucket markup that you can use to link to Bitbucket objects from wikis.

In some cases, you can use a Bitbucket macro or the Bitbucket markup to do the same thing. The Bitbucket markup works in all languages; The Bitbucket macros work only with Creole markup.

Supported File Extensions

With the exception of Creole markup, Bitbucket supports the same markup in README files as it does in wiki files. The table below lists the supported filename extensions and their corresponding mark up languages:
Extension
Language

.md
.mkd
.mkdn
.mdown
.markdown 
.text 

Markdown

We support Python-Markdown  and the following extensions codehilite, tables, def_list, del, footnotes, headerid, sane_lists, abbr, fenced_code, toc, wikilinks. However, we don't support arbitrary HTML in Markdown, for example  <table> tags. Instead, we use safe mode. Safe mode requires that you  replace, remove, or escape HTML tags appropriately.

.rst

reStructuredText (reST)

.textile Textile
.wiki

Creole

For Bitbucket wikis only, not supported with README files.

If you have a defined a setup.py file in your repository's root, Bitbucket parses files without an extension or that use the .txt extension as reST also.  If you do not define a setup.py file, these files render as plain text.  

Detailed Wiki How To Guides

The following pages provide detailed information on using a Bitbucket Cloud wiki.

Was this helpful?

Thanks for your feedback!

Why was this unhelpful?

Have a question about this article?

See questions about this article

Powered by Confluence and Scroll Viewport