feat(option): render description markdown#42
Merged
water-sucks merged 9 commits intomainfrom Aug 26, 2024
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
I've been wanting to do this for a while.
Most option descriptions have extra markup related to
nixpkgs, and are written in Markdown.I wanted to parse this markdown and render it myself using ANSI codes. That's what this PR brings in; it parses markdown using https://github.com/kivikakk/koino, and adds ANSI codes to the descriptions.
The code is crude, but it gets the job done. I'll address how to do this properly (such as adding proper indentations, fixing bugs) later. It can be disabled in the config using
option.prettify=falseif it does mess up with rendering some options.This is an example of the new description rendering.
Closes #26.