# Rendering of README.md

**URL:** <https://librepcb.discourse.group/t/rendering-of-readme-md/854>\
**Category:** Improvement Ideas\
**Created:** [December 5, 2024, 12:10pm UTC](https://librepcb.discourse.group/t/rendering-of-readme-md/854 "2024-12-05T12:10:42Z")\
**Posts on this page:** 4\
**Page:** 1

<div class="post-metadata">

**Author:** ![grubernd](https://yyz2.discourse-cdn.com/free1/user_avatar/librepcb.discourse.group/grubernd/32/651_2.png) [@grubernd](https://librepcb.discourse.group/u/grubernd)\
**Post date:** [December 5, 2024, 12:10pm UTC](https://librepcb.discourse.group/t/rendering-of-readme-md/854/1 "2024-12-05T12:10:42Z")

</div>

Hi,

first post, so let’s start with a big thank you for creating a great application.

Back on topic:

Being a longtime user of all kinds of flavours of markdown I noticed some peculiar behaviour of the rendering in the Control Panel using the 1.1.0 release.

For example:

- **BOLD** is rendering the whole line and not just the beginning
- Tickboxes on lists are “removed”, possibly interpreted as empty links

Discourse renders these examples what I would consider as correct.

Personally I prefer the definition done by [https://commonmark.org/](https://commonmark.org/) and use their reference implementation in C for markdown conversions.

==\> [GitHub - commonmark/cmark: CommonMark parsing and rendering library and program in C](https://github.com/commonmark/cmark)

Maybe something to consider for a future release.

Greetings from Austria =)

---

<div class="post-metadata">

**Author:** ![ubruhin](https://avatars.discourse-cdn.com/v4/letter/u/c89c15/32.png) [@ubruhin](https://librepcb.discourse.group/u/ubruhin)\
**Post date:** [December 5, 2024, 1:02pm UTC](https://librepcb.discourse.group/t/rendering-of-readme-md/854/2 "2024-12-05T13:02:24Z")

</div>

Servus @grubernd,

Thanks for the kind words, glad to hear you like LibrePCB 😊

To keep the number of external dependencies at a minimum, we use Qt-builtin functionality to render Markdown: [QTextEdit Class | Qt Widgets 6.8.1](https://doc.qt.io/qt-6/qtextedit.html#markdown-prop)

Actually they support CommonMark syntax and GitHub syntax, while we currently use GitHub syntax. But actually, as far as I understand, GitHub syntax is CommonMark with a few extensions, so there would be no advantage of switching to CommonMark(?)

IIRC tickboxes are not supported in CommonMark at all.

The wrong rendering could also be a bug in Qt. Did you already try with LibrePCB 1.2.0 which just came out?

Urban

---

<div class="post-metadata">

**Author:** ![grubernd](https://yyz2.discourse-cdn.com/free1/user_avatar/librepcb.discourse.group/grubernd/32/651_2.png) [@grubernd](https://librepcb.discourse.group/u/grubernd)\
**Post date:** [December 5, 2024, 3:36pm UTC](https://librepcb.discourse.group/t/rendering-of-readme-md/854/3 "2024-12-05T15:36:47Z")

</div>

No, I have not tried the new 1.2.0.

… a few minutes later …

LOL.

Both peculiarities are gone.  
And there are real tickboxes now, both ticked and unticked.

Added the blog-feed to my reader to not miss out on future updates. =)

---

<div class="post-metadata">

**Author:** ![ubruhin](https://avatars.discourse-cdn.com/v4/letter/u/c89c15/32.png) [@ubruhin](https://librepcb.discourse.group/u/ubruhin)\
**Post date:** [December 5, 2024, 4:54pm UTC](https://librepcb.discourse.group/t/rendering-of-readme-md/854/4 "2024-12-05T16:54:34Z")

</div>

Haha awesome! 😃