community icon indicating copy to clipboard operation
community copied to clipboard

[INS-2160] [Improvement] Render --help as markdown

Open TobiaszCudnik opened this issue 1 year ago • 4 comments

Is There an Existing Issue for This?

  • [X] I have searched the existing issues

Project

Instill CLI

Is your Proposal Related to a Problem?

No

Describe Your Proposed Improvement

Using the glow module, we can show a well formatted help messages.

Highlight the Benefits

Readability and nice UI.

Anything Else?

No response

INS-2160

TobiaszCudnik avatar Sep 27 '23 07:09 TobiaszCudnik

This issue is a great way to kick-start your journey with our project, or to make a positive impact on open-source development. Jump in!

:sparkles: Thank you for your contribution! :sparkles:

github-actions[bot] avatar Sep 27 '23 07:09 github-actions[bot]

Can I take this one?

syedzubeen avatar Oct 02 '23 23:10 syedzubeen

@syedzubeen Absolutely. Thanks for being interested in contributing.

pinglin avatar Oct 06 '23 02:10 pinglin

@harshsoni7 Glow seems like a plug-and-play kind of thing. You install it and render markdowns on your terminal. It doesn't seem to provide any functions to integrate it with an existing go CLI. There isn't any documentation as such on https://pkg.go.dev/github.com/charmbracelet/glow#section-documentation

Correct me if I am wrong here. However, I see another package by the same vendor named lipgloss that does CLI output styling. https://pkg.go.dev/github.com/charmbracelet/lipgloss

syedzubeen avatar Oct 21 '23 01:10 syedzubeen