Skip to content

Early attempt at markdown rendering #204

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

Closed
wants to merge 27 commits into from
Closed

Conversation

mcon
Copy link
Contributor

@mcon mcon commented Jan 3, 2021

Fairly early days with this PR, but most commonly used markdown supported, notable items not supported:

  • Abbreviations
  • Definition lists
  • Auto links
  • Footers

Example output:
image
image

Questions / TODOs:

  • Would be nice to split test markdown into separate testcases
  • Are you happy with the rendering of the different document elements, spacing etc?
  • Given there's a dependency added on Markdig, I'm assuming you'd prefer a separate package as I've done?
  • Public doc comments
  • Check that the CustomRenderable added in Rule is fully consistent, add a test for it
  • Ensure unit tests use a mocked HttpClient

@mcon mcon marked this pull request as ready for review January 3, 2021 11:35
@mcon mcon mentioned this pull request Jan 3, 2021
@patriksvensson
Copy link
Contributor

@mcon Awesome! I know the PR isn't ready yet, but could we rename the module from Spectre.Console.Markdig to Spectre.Console.Markdown?

@khalidabuhakmeh
Copy link
Contributor

Any chance you can include screenshots in this PR.

@patriksvensson
Copy link
Contributor

@mcon Closing this due to inactivity. Feel free to reopen it if you want to continue working on it!

@SuperJMN
Copy link

Is this being worked? I'd like to render basic markdown to the console :)

@mcon
Copy link
Contributor Author

mcon commented Oct 2, 2021

Is this being worked? I'd like to render basic markdown to the console :)

Hi @SuperJMN I'm not working on this one - feel free to continue where I left off!

@enginexon
Copy link

@patriksvensson
Is this still interesting topic for community? Was it already implemented?

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

Successfully merging this pull request may close these issues.

5 participants