add-markdown-to-dashboard.md

title	titleSuffix	description	ms.custom	ms.prod	ms.technology	ms.topic	ms.manager	ms.author	author	monikerRange	ms.date
Add markdown content to a team dashboard	Azure DevOps	Add and configure the Markdown widget you add to a team dashboard	dashboards	devops	devops-analytics	quickstart	jillfra	kaelli	KathrynEE	>= tfs-2015	11/19/2018

Add Markdown to a dashboard

[!INCLUDE temp]

Use the Markdown widget to support your team and stakeholders by adding information such as:

• Team goals
• Provide links to team backlogs or boards, metrics, or other items located in a network share such as a OneNote, SharePoint site or wiki pages
• Important dates or target deadlines

Here's an example:

[!INCLUDE temp]

Connect to your project

To add the markdown widget to a dashboard, you connect to your project using a supported web browser.

::: moniker range=">= azure-devops-2019"
Open a web browser, connect to your project, and choose Overview>Dashboards.

[!div class="mx-imgBorder"]

If you need to switch to a different project, choose the Azure DevOps logo to browse all projects.

::: moniker-end

::: moniker range=">= tfs-2015 <= tfs-2018"

Open a web browser, connect to your project, and choose Dashboards.

If you need to switch to a different project, choose the Azure DevOps logo to browse all projects and teams.

::: moniker-end

Add the markdown widget

If you need to add a dashboard, see Add, rename, and delete dashboards.

::: moniker range="tfs-2015"

Note

Requires TFS 2015.1 or later version.
::: moniker-end

::: moniker range=">= azure-devops-2019" To add the markdown widget to the dashboard, choose Edit. The widget catalog will automatically open.

0. Add or drag the Markdown widget onto the dashboard where you want it located.

   

1. Choose Done Editing to exit dashboard editing. This will dismiss the widget catalog. You can then configure the markdown widget as needed.

2. Choose the gear icon to open the configuration dialog for the widget.

   To edit a markdown widget, you may need to be a team admin, a member of the Project Administrators group, or be granted permissions. To learn more, see Set dashboard permissions.

3. Adjust the widget size as needed to fit the contents of the markdown you'll enter. The largest size is 10 tiles wide by 10 tiles tall. You can always adjust this later.

   

4. Enter the text and markdown syntax into the configuration the configuration dialog. For supported syntax, see Syntax guidance for Markdown files, widgets, wikis, and pull request comments.

   Here we show some simple text with a bulleted list of four links

   

   [!TIP]
   To link to a wiki page,use the following syntax:
   /ProjectName/_wiki/wikis/WikiRepositoryName?pagePath=/FileName

   To link to a repository file, page, or image within the project, rich-click the file and use the full URL.

   This renders the following widget:

   

   [!NOTE]
   Links to documents on file shares using file:// are not supported. This restriction has been implemented for security purposes.

5. Optionally, you can choose to point to a file in your repository.

   

::: moniker-end

::: moniker range=">= tfs-2015 <= tfs-2018"

0. Choose to modify a dashboard.

1. Choose to open the widget catalog.

2. Drag the Markdown widget onto the dashboard where you want it located.

   

3. Choose the gear icon to open the configuration dialog for the widget.

   To edit a markdown widget, you may need to be a team admin, a member of the Project Administrators group, or be granted permissions. To learn more, see Set dashboard permissions.

4. Adjust the widget size as needed to fit the contents of the markdown you'll enter. The largest size is 10 tiles wide by 10 tiles tall. You can always adjust this later.

   

5. Enter the text and markdown syntax into the configuration the configuration dialog. For supported syntax, see Syntax guidance for Markdown files, widgets, wikis, and pull request comments.

   Here we show some simple text with a bulleted list of four links

   

   To link to a wiki page, repository file, or page within the project, use this format:

   /DefaultCollection/Fabrikam%20Fiber/Voice/_wiki?pagePath=%2FHome /DefaultCollection/Fabrikam%20Fiber/Voice/_git/Fabrikam%20Fiber?path=%2FREADME.md /DefaultCollection/Fabrikam%20Fiber/Voice/_backlogs?level=Backlog%20items&showParents=false&_a=backlog

   This renders the following widget:

   

   [!NOTE]
   Links to documents on file shares using file:// are not supported on TFS 2017.1 and later versions. This restriction has been implemented for security purposes.

6. Optionally, you can choose to point to a file in your repository.

   

7. If you haven't closed the widget catalog yet, do that now.

8. If you want to reposition the markdown widget or other widgets on the dashboard, do that now while you're still in dashboard edit mode.

9. When you're finished with your changes, choose to exit dashboard editing. ::: moniker-end

Related articles

• Add and manage dashboards
• Add a widget to a dashboard
• Syntax guidance for Markdown files, widgets, wikis, and pull request comments
• Marketplace widgets