Add Markdown support - Githubissues

fpv-wtf / wtfos-configurator

Configurator for wtfos, with built in margerine

GNU Affero General Public License v3.0

42 stars 16 forks source link

Add Markdown support #343

Closed stylesuxx closed 1 year ago

stylesuxx commented 1 year ago

As discusses in #342 - Markdown support might be useful in different places.

Add Markdown support to the package Detail place as first POC and proof of styling.

benlumley commented 1 year ago

I think the markdown support is a good idea.

However; in the case of msp-osd; the readme is long. It'll push the config section way way down.

Thoughts on:

go with it. people can scroll.
config form first
config form first; but in a collapsible section, default collapsed
only display start of package description and link to the full version if needed
Fix MSP-OSD readme - break it out to separate pages or something.
something else???

stylesuxx commented 1 year ago

Pulling the Readme in, I think would be a separate issue at all. I was just thinking that the fields that we are currently showing could have Markdown - like the description for instance.

But yeah, for rendering the Readme I would suggest we show the first couple lines, let it fade out on the bottom and simply place a "Read more" button beneath which expands it fully.