mergesort / Recap

A What's New screen, and more
MIT License
161 stars 5 forks source link

[discussion] Full markdown support? #16

Open jverkoey opened 1 day ago

jverkoey commented 1 day ago

As I'm writing my second release notes for Sidecar I'm finding I'd love to be able to embed screenshots (or even interactive views) into the release notes in some manner.

This then got me thinking that as more of these kind of features get added, it might be beneficial to evaluate use of a more robust Markdown parser with the option for controlling the stylesheet. The current approach works well, and I like it, so this issue is more meant to spark a discussion than necessarily indicate a request.

As a reference, I did something similar in Slipstream and it's been pretty handy. The mechanism I used to build this affords for "theme" reusability while also being quite configurable in that you have full control over how individual Markdown elements are rendered:

https://github.com/ClutchEngineering/slipstream/blob/58353439118c5b0456866cb0e8d287977475d54d/Sources/Slipstream/Markdown/MarkdownText.swift#L25-L42

e.g. from jeffverkoeyen.com (probably the most complex Markdown Slipstream renderer thus far because it also supports Swift syntax highlighting): https://github.com/featherless/jeffverkoeyen.com/blob/058c5328328c58b8d99d17950c2554f9cf680e76/Sources/Site/MarkdownTheme/Article.swift#L87