search

nedbat / scriv

Changelog management tool
https://scriv.readthedocs.io
Apache License 2.0
256 stars 28 forks source link

fix: place .md anchors immediately before title #49

Closed rodrigogiraoserrao closed 2 years ago

rodrigogiraoserrao commented 2 years ago

Hey!

I am going to go out on a limb here and assume that you decided to place a blank line between the <a .. /> anchor and the title because of your experience with .rst files. However, as far as I can tell, .md files typically have their anchors next to the titles. This is pretty much a matter of style, so I reckon the chances of this PR being rejected are high, but I thought it wouldn't hurt to try!

Thanks for your work on scriv.

rodrigogiraoserrao commented 2 years ago

I changed the style from a self-closing <a ... /> tag to <a ...></a> because GitHub doesn't seem to know how to render the self-closing tags when next to titles. Also, this SO answer presents other points in favour of non-self-closing tags.

nedbat commented 2 years ago

Thanks. I hadn't tried explicit closing, and the extra blank line was needed with self-closing to get it to render properly.