-
Notifications
You must be signed in to change notification settings - Fork 113
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
Add support for Markdown in TUI, console, clipboard output #427
Open
danschwarz
wants to merge
10
commits into
ihabunek:master
Choose a base branch
from
danschwarz:markdown-pandoc
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Conversation
This file contains 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
(This is a fallback from rendering using urwidgets, if urwidgets library is not available.)
It's not working right for multiline statuses that start with a # character
Also used for markdown rendering in console and copy-to-clipboard
Now we default to markdown when displaying status messages; the --plaintext option reverts to previous behavior. This switch is used in test_console.py so existing tests will pass; we can add tests in future without --plaintext to test the markdown rendering.
danschwarz
force-pushed
the
markdown-pandoc
branch
from
November 28, 2023 01:30
4be27f8
to
1e8c5f1
Compare
Markdown is specified by using the -md or --markdown option
Switched it to default to plaintext (as it was originally) and use the -md / --markdown option to render as markdown. Makes more sense this way. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
As it turns out, the
pandoc
utility, withpypandoc
Python bindings, do a better job converting HTML to markdown thanhtml2text
ormarkdownify
libraries.Pandoc
is widely used and maintained, in contrast to the other libraries.In the TUI, statuses are rendered in HTML by
urwidgets
if available, fallback is markdown (viapandoc
if available), and finally plaintext if neitherurwidgets
norpandoc
are available.In the console and clipboard, status rendering is in markdown via
pandoc
, fallback to plaintext ifpandoc
is not available.TODO:
Here's an example of markdown rendering in the TUI. This is using github-flavored-markdown, FWIW.
This addresses issue #416 .