question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Support Markdown in game descriptions

See original GitHub issue

The fact that Playnite expects game descriptions to be HTML caused some minor confusion in the past (#349); even though there’s a informative tooltip now, it might still cause confusion - especially because I think that most users don’t know what HTML is. Nevertheless is supporting HTML important because some stores use HTML for their game descriptions.

I suggest that the game description field supports Markdown. I guess everyone here on GitHub knows what Markdown is, so I think that I don’t have to explain it. The biggest advantage of Markdown is that it is very intuitive (most importantly: paragraphs work as expected) and its simplicity - and, to return to the above “We must support HTML” requirement, it doesn’t interfere with HTML in any way and it simply passes HTML through without any change. Just to emphasis this, Markdown parsers don’t interpret Markdown inside HTML block elements - thus some * somewhere in a game description from Steam won’t be parsed as Markdown. Consequently, adding Markdown-support doesn’t break backwards compatibility.

I suggest using a CommonMark-compatible parser. There are some C# Markdown parsers out there Playnite could use (e.g. lunet-io/markdig or Knagis/CommonMark.NET).

Issue Analytics

  • State:open
  • Created 6 years ago
  • Reactions:3
  • Comments:8 (2 by maintainers)

github_iconTop GitHub Comments

1reaction
JosefNemeccommented, Jan 5, 2018

I would actually don’t mind getting rid of HTML support (yes we would have to convert Steam and GOG descriptions) in favor of something that doesn’t render into HTML but FlowDocument instead (like Markdown.XAML).

It would be faster and provide more unified look with the rest of application. Currently HTML descriptions are rendered by HtmlRenderer.WPF, which is basically no longer maintained and has several issues with how the output looks.

0reactions
chocolatechipcatscommented, Nov 30, 2020

Markdown would be much preferable.

Hopefully whatever converter you use will be able to handle some of the walls-of-HTML that tend to be downloaded from the Steam store.

Read more comments on GitHub >

github_iconTop Results From Across the Web

Markdown | gotm.io
When a game developer or player wants to add a description to their game or their profile page, they can make the description...
Read more >
Steam Markdown support : r/Steam
BB codes are a derelict of the past that should be purged or why is Markdown your best bet today. BB codes are...
Read more >
Markdown
Markdown is a cinch to learn. You can use the cheat sheet below to familiarize yourself with the most commonly used elements.
Read more >
Allow markdown in place description - Website Features
It would allow developers to add more detailed information to their descriptions. Bold text to enhance keywords, dropdowns to show new/updated ...
Read more >
Use Markdown formatting in Microsoft Teams
With Markdown, you get a live preview of your formatted text inside your compose box as you type, and you can always undo...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found