PR Guidelines not rendering code.
Hi,
I have a CONTRIBUTING.md
file with a "code" section. Unfortunately that section is not properly rendered, as it is clearly visible from this screenshot:
I attached the original CONTRIBUTING.md
.
Thank you very much for your support.
Nicholas
Comments (6)
-
reporter -
Account Deactivated Thank you for bringing this to my attention @NicholasFiorentini.
It looks like prguidelines is having trouble with level 1 and level 2 headers inside the code block. Did you mean for the code block to contain those headers verbatim?
This is an interesting use-case and I'll try to make prguidelines deal with this better. In the mean time, maybe you can try not having level 1 and 2 headers inside the codeblock. I'll update this ticket when I have a fix and maybe then you could reintroduce those headers.
Sorry for the inconvenience.
-
Account Deactivated - changed status to resolved
parser: Fix issue
#9The parser needs to copy the contents of a code block verbatim instead of trying to parse them and figuring out topics and sections from it.
→ <<cset 8983a6538688>>
-
Account Deactivated Hi @NicholasFiorentini,
I ended up working on it and I think I have a fix. I've merged the fix into master but I'll deploy it later. I'm confident that it'll solve this issue, but I'll reopen this ticket if it doesn't.
-
Account Deactivated Hi @NicholasFiorentini,
I've deployed the changes. Could you please try reloading the guidelines dialog and see if it works this time?
I tried your CONTRIBUTING.md file. It seems to work for me, but the formatting still looks a bit funny to me.
-
reporter HI @abhin,
thank you for your prompt reply. Regarding your original question, yes: I want the code block to contain those headers verbatim. The use case is to provide a "ready to use" pull request's description to my developers, so that all PRs have the same structure. The developers have only to fill the descriptions properly.
I immediately tried and now I can see the text, yet the original markdown is still missing:
Please consider that Bitbucket is rendering the file as expected when you open it inside the "Source" panel.
Thanks again for your support.
Best Regards,
Nicholas
- Log in to comment
To clarify, I'm using Bitbucket Cloud with a Git repository.