Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
1 task done
TobiaszCudnik opened this issue Sep 27, 2023 · 4 comments
Open
1 task done

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

TobiaszCudnik opened this issue Sep 27, 2023 · 4 comments

Comments

@TobiaszCudnik
Copy link
Contributor

TobiaszCudnik commented Sep 27, 2023

Is There an Existing Issue for This?

  • 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 TobiaszCudnik changed the title [Improvement] Render --help as markdown [INS-2160] [Improvement] Render --help as markdown Sep 27, 2023
@github-actions
Copy link

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!

✨ Thank you for your contribution! ✨

@syedzubeen
Copy link

Can I take this one?

@harshsoni7 harshsoni7 assigned syedzubeen and unassigned syedzubeen Oct 4, 2023
@pinglin
Copy link
Member

pinglin commented Oct 6, 2023

@syedzubeen Absolutely. Thanks for being interested in contributing.

@syedzubeen
Copy link

@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

@pinglin pinglin transferred this issue from instill-ai/community May 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants