Come for the products,
stay for the community

The Atlassian Community can help you and your team get more value out of Atlassian products and practices.

Atlassian Community about banner
4,367,539
Community Members
 
Community Events
168
Community Groups

Bitbucket RestructuredText README ugly?

Edited

RestructuredText README's on Bitbucket looks improperly rendered into HTML at the moment, e.g.

* all the sections are squashed up

* the headings are rendered as hyperlinks that point to themselves

I see that this is a new feature, is it intended to be improved any time soon or is markdown the way to go for now?

 

1 comment

The problem is that sections, which are usually started by headings, do not have any margin defined for them. Meanwhile, the heading that starts a section will be the first child element within that section.

In the bundle.css file that apparently applies to the HTML output, there is a CSS rule like this:

/* remove top margin for first element */
p:first-child,
ul:first-child,
ol:first-child,
dl:first-child,
h1:first-child,
h2:first-child,
h3:first-child,
h4:first-child,
h5:first-child,
h6:first-child,
blockquote:first-child,
pre:first-child,
form:first-child,
table:first-child {
margin-top: 0;
}

So, each section will not have a top margin, each heading at the top of each section will not have a top margin. Consequently, sections will be squashed up.

I suggest that some kind of top margin be incorporated into the rules. Removing the above rule does produce decent-enough layout for my documentation, but others might not entirely agree with what it does to theirs.

Comment

Log in or Sign up to comment
TAGS

Atlassian Community Events