1. Bitbucket Website
  2. Public Issue Tracker
  3. master


Issue #2904 open

README file with markdown preamble is not parsed anymore (BB-4431)

Samuel Dionne-Riel
created an issue

With the latest UI updates, a README file with the markdown comment preamble is not parsed anymore.

Here's an example repository: https://bitbucket.org/anhero/redboxapp

Here's the preamble used {{{ <!-- -- markdown -- --> }}}

as recommended here http://confluence.atlassian.com/display/BITBUCKET/Displaying+README+Text+on+your+Bitbucket+Source+Tab


Comments (5)

  1. Brodie Rao

    We recently reworked the code that renders READMEs on the overview page and decided to remove support for preambles for a couple of reasons:

    • We've had support for a while for specifying the README's format by putting it in the file extension. E.g., README.md is parsed as Markdown.
    • We felt it wasn't ideal to have to add cruft to READMEs to get them to render correctly.

    I've updated the documentation to reflect how we handle READMEs now. If you rename your README to README.md, you should be good to go.

  2. Michał Górny

    Is it ideal to have to add cruft to README's filename, directly causing it to be unrecognized by autotools and not following the GNU coding standards? I thought the main point for using markups like rst is to have READMEs which are as good both as a markup, and as plain text.

  3. Pierre de Buyl

    Having a repository setting that allows to manually set the README format would be good. In some circumstances, the name of the README has to be "README" without extension. Then, it is not possible to have a properly rendered README in the repository overview.

    In "Repository details", a field "README default format" with values "Text", "Markdown", "reStructuredText" and "Textile".

  4. Log in to comment