mirror of https://github.com/Textualize/rich.git
22 lines
663 B
ReStructuredText
22 lines
663 B
ReStructuredText
|
Markdown
|
||
|
|
========
|
||
|
|
|
||
|
|
Rich can render Markdown to the console. To render markdown, construct a :class:`~rich.markdown.Markdown` object then print it to the console. Markdown is a great way of adding rich content to your command line applications. Here's an example of use::
|
||
|
|
|
||
|
|
MARKDOWN = """
|
||
|
|
# This is a h1
|
||
|
|
|
||
|
|
Rich can do a pretty *decent* job of rendering markdown.
|
||
|
|
|
||
|
|
1. This is a list item
|
||
|
|
2. This is another list item
|
||
|
|
"""
|
||
|
|
from rich.console import Console
|
||
|
|
from rich.markdown import Markdown
|
||
|
|
|
||
|
|
console = Console()
|
||
|
|
md = Markdown(MARKDOWN)
|
||
|
|
console.print(md)
|
||
|
|
|
||
|
|
Note that code blocks are rendered with full syntax highlighting!
|
||
|
|
|