Documentation

Learn how to view and edit Markdown files in Bitbucket Cloud with a richer editor and live split-screen preview.

01Getting started

Markdown Plus for Bitbucket Cloud improves the experience of viewing and editing Markdown files in Bitbucket — with a richer renderer and a split-screen editor with live preview.

i

Before you begin: install the app from the Atlassian Marketplace. Once installed, the Markdown Plus viewer option appears automatically in the file viewer — no configuration required. A free 30-day trial is available.

To view a file with Markdown Plus, open a Markdown file in a repository and click Default File Viewer → Markdown Plus Viewer.

i

To view a repository's README with Markdown Plus, first open the file from the file browser rather than the repository landing page.

File viewer dropdown showing Markdown Plus Viewer option
Selecting Markdown Plus Viewer from the file viewer dropdown.

To edit a file, click the Edit button — the Markdown Plus editor will open with a split-screen preview. Toggle the preview pane on or off with the Toggle Preview button.

Markdown Plus editor with split-screen preview
The Markdown Plus editor showing the split-screen editing view.

If you encounter anything unexpected or have suggestions, click Send Feedback to submit a ticket to our support desk.

02FAQ

Which Markdown syntax is supported?

Markdown Plus renders CommonMark-compatible Markdown, including headings, bold and italic text, code blocks with syntax highlighting, tables, and ordered and unordered lists.

Can I edit Markdown files directly in Bitbucket?

Yes. Open any Markdown file and click Edit — the Markdown Plus editor opens with a split-screen live preview so you can see your changes rendered as you type.

Does this work with the repository README?

Yes, but you need to open the README from the file browser rather than the repository landing page. Once open as a file, select Markdown Plus Viewer from the file viewer dropdown.

Which Bitbucket plans does this work with?

Markdown Plus works with all Bitbucket Cloud plans, including Free, Standard and Premium. It is not compatible with Bitbucket Data Center or Server.

Is my data sent to Atly's servers?

No. Markdown Plus runs entirely in your browser as a Bitbucket Connect app. Your file content is never sent to or stored on Atly's servers.