-
Suggestion
-
Resolution: Unresolved
-
None
-
None
-
1
-
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.
Form Name |
---|
Source control for a knowledge management repository requires some method to add meta data to a file. It seems that the yaml header is quickly gaining wide adoption for markdown based knowledge management solutions, even though it is unlikely to become an official standard for perfectly valid reasons.
This feature would enable Bitbucket to add new metadata based features that are not possible today. I do not recommend using Bitbucket for a knowledge management repository until a method for adding metadata is supported.