# rich-rst

Contents:

- Demonstration
  - Demo Files
  - Parameters Used
  - Sources
- Documentation
  - `RestructuredText`
  - `ReStructuredText`
  - `reStructuredText`
  - `reST`
  - `RST`

Firstly, I’d like to thank you for using rich-rst.

## Installation

Run the following command to install

    python -m pip install rich-rst

If you want to live on the edge and install from master branch that may be unstable, run the following command.

    python -m pip install "git+https://github.com/wasi-master/rich-rst"

Here, you may need to replace `python` with `python3` on Linux and Mac and with `py` on Windows

## Usage

If you want to print a RST document then you can use the following code

    import rich
    from rich_rst import RestructuredText

    rst_text = "Hello *World!*"

    rich.print(RestructuredText(rst_text, code_theme="dracula", show_errors=False))

Here rst_text is just a example and you should change it to your desired RST text. The parameters for the constructor are documented in documentation

## Contributing

Since the project is open source and The source code is available on github so you can easily see the repository issues page and help in that way. I am open to new pull requests and issues and will look into each and every one of them

# Indices and tables

- Index

- Module Index

- Search Page

- Documentation

- Demonstration