Uploaded image for project: 'Bitbucket Data Center'
  1. Bitbucket Data Center
  2. BSERV-10580

Recognize YAML header in Markdown files

XMLWordPrintable

    • 3
    • We collect Bitbucket feedback from various sources, and we evaluate what we've collected when planning our product roadmap. To understand how this piece of feedback will be reviewed, see our Implementation of New Features Policy.

      DocFX Flavored Markdown files can contain a YAML header. I would like Bitbucket Server to recognize this syntax when it renders a Markdown file to which I have navigated in the repository file browser. Currently, Bitbucket Server v5.6.2 renders the first triple-dash line as a horizontal rule and the rest as a setext heading.

      ---
uid: data-dictionary.md
title: Data Dictionary
---

      GitHub also seems to recognize this syntax, as evidenced in https://github.com/dotnet/docs/blob/VS2017/docs/csharp/csharp.md, even though GitHub Flavored Markdown Spec Version 0.28-gfm does not mention it.

      To minimize the compatibility risk, perhaps it would be best to recognize the YAML header only at the top of the file, where users are unlikely to intend a horizontal rule.

            Unassigned Unassigned
            bce11fd9005e Kalle Niemitalo
            Votes:
            17 Vote for this issue
            Watchers:
            19 Start watching this issue

              Created:
              Updated: