feat: Added HTML output option

[Vyvy-vi]

Summary

This PR adds an output_type option that allows users to take advantage of HTML formatting features.

Type of change

• Bug fix (added a non-breaking change which fixes an issue)
• New feature (added a non-breaking change which adds functionality)
• Updated documentation (updated the readme, templates, or other repo files)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)

How Has This Been Tested?

• Added or updated test cases to test new features

closes #24

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Updated
ytcards	✅ Ready (Inspect)	Visit Preview	Nov 4, 2022 at 9:16PM (UTC)

[DenverCoder1]

Looks good, just a few small fixes.

Also there is a place in the readme (around line 94) that this can be documented

[Vyvy-vi]

I think the HTML output option should also be documented somewhere in the wiki.
Also, should the markdown output passed from the github action be renamed to avoid confusion?

[DenverCoder1]

Should the markdown output passed from the github action be renamed to avoid confusion?

It's a good question.

I think it shouldn't be renamed since that could be a breaking change in the case that people are currently using it. It might be better to instead possibly add "html" as a second output option.

If you want to do it in this PR, you can, but it could also be done later.

Also see this comment for a possible solution - #25 (comment)

If you think it's not worth outputting all of the types, it might be fine to just change the "markdown" to a different name that could be for any output type including HTML or JSON since I don't know that many repos are currently using the "markdown" output option (besides this one).

[DenverCoder1]

Looks good!

See above comment, though. I'm not sure what's best and I'm happy to hear your thoughts on it.

[Vyvy-vi]

I guess we could leave it as it is, add a new output for json when #25 gets resolved and document the output_type input option.
The HTML output is still valid markdown for GitHub, so it shouldn't be very confusing.

[DenverCoder1]

Sounds good!

I suppose we don't even need output_type: json, but just always having a second output for json would be simpler.

And I agree that having markdown be either Markdown or HTML makes sense.

[DenverCoder1]

We should probably document the two values that are allowed.

Besides that, I think this is good to merge.

[DenverCoder1]

Thanks!