mirror of https://github.com/Textualize/rich.git
42 lines
1.5 KiB
ReStructuredText
42 lines
1.5 KiB
ReStructuredText
.. _console_markup:
|
|
|
|
Console Markup
|
|
==============
|
|
|
|
Rich supports a simple markup which you can use to insert color and styles virtually everywhere Rich would accept a string (e.g. :meth:`~rich.console.Console.print` and :meth:`~rich.console.Console.log`).
|
|
|
|
|
|
Formatting
|
|
----------
|
|
|
|
for bold, italic, and strikethrough, Rich uses the same convention as Markdown::
|
|
|
|
For italics, wrap text in asterisks or underscores, e.g. ``*this is italics*`` or ``_this is also italics_``.
|
|
|
|
For bold, wrap the text in *two* asterisks or underscores. e.g. ``**this is bold**`` or ``__this is also bold__``.
|
|
|
|
For strikethrough, wrap the text in tildes. e.g. ``~this has a line through it~``.
|
|
|
|
For code, wrap the text in backticks. e.g. ```import this```
|
|
|
|
|
|
Styling
|
|
-------
|
|
|
|
For other styles and color, you can use a syntax similar to bbcode. If you write the style (see :ref:`styles`) in square brackets, i.e. ``[bold red]``, that style will apply until it is *closed* with a corresponding ``[/bold red]``.
|
|
|
|
Here's a simple example::
|
|
|
|
from rich import print
|
|
print("Hello, **World**!")
|
|
print("[bold red]alert![/bold red] *Something happened*")
|
|
|
|
If you don't close a style, it will apply until the end of the string. Which is sometimes convenient if you want to style a single line. For example::
|
|
|
|
print("[bold italic yellow on red blink]This text is impossible to read")
|
|
|
|
There is a shorthand for closing a style. If you omit the style name from the closing tag, Rich will close the last style. For example::
|
|
|
|
print("[bold red]Bold and red[/] not bold or red")
|
|
|