sailfishos-chum / sailfishos-chum-gui

GUI application for utilising the SailfishOS:Chum community repository
https://openrepos.net/content/olf/sailfishoschum-gui-installer
MIT License
13 stars 17 forks source link

Add an url to a readme (markdown) to the package #73

Closed rinigus closed 2 years ago

rinigus commented 2 years ago

It would be nice to add an url to a readme (markdown) to the package:

name: Dummy App
type: desktop-application # not sure we need that
categories:
- Media
custom:
- repo: https://github.com//johndoe/harbour-dummy-app/
icon: https://raw.githubusercontent.com//johndoe/harbour-dummy-app/master/harbour-dummy-app.svg
screenshots:
- https://github.com/johndoe/harbour-dummy-app/raw/master/metadata/screenshots/screenshot1.png
- https://github.com//johndoe/harbour-dummy-app/raw/master/metadata/screenshots/screenshot2.png
- https://github.com//johndoe/harbour-dummy-app/raw/master/metadata/screenshots/screenshot3.png
url:
- donation: https://www.paypal.me/johndoe
- readme: https://github.com/johndoe/harbour-dummy-app/raw/master/README.md

This could be rendered in Chum GUI instead of the description if present.

Originally posted by @black-sheep-dev in https://github.com/sailfishos-chum/main/issues/29#issuecomment-1008158448

rinigus commented 2 years ago

@black-sheep-dev: Such rendering would require markdown processing, wouldn't it? So far we have used GitHub HTML output in GraphQL (issues, releases) and there was no need to handle MD. Any recommendations regarding it?

In terms of formatting, notice that we use capitalized tags ("Url" and not "url")

black-sheep-dev commented 2 years ago

I used showdown.js javascript library inside SailHub to render markdown text. I only add some additional styling to the rendered html.

Attached a small example example.zip

rinigus commented 2 years ago

Thanks, that is very helpful!

I can see I forgot yo reply regarding Type: desktop-application. That's needed as we also have console apps and libraries in Chum. In particular, end users are not very much interested in libs as those are pulled as a dependency.

black-sheep-dev commented 2 years ago

I also tried the C++ renderer Maddy but showdown renders better in my opinion