{"id":23749496,"url":"https://github.com/wasi-master/rich-rst","last_synced_at":"2026-05-11T00:16:50.621Z","repository":{"id":42002855,"uuid":"455873874","full_name":"wasi-master/rich-rst","owner":"wasi-master","description":"A reStructuredText renderer for rich","archived":false,"fork":false,"pushed_at":"2024-04-30T08:08:12.000Z","size":483,"stargazers_count":14,"open_issues_count":2,"forks_count":3,"subscribers_count":3,"default_branch":"main","last_synced_at":"2024-10-29T02:18:42.970Z","etag":null,"topics":["cli","command-line-interface","docutils","python","python3","restructuredtext","rich","rst","sphinx"],"latest_commit_sha":null,"homepage":"https://rich-rst.readthedocs.io/en/latest/","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/wasi-master.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-02-05T13:13:32.000Z","updated_at":"2024-10-23T11:00:21.000Z","dependencies_parsed_at":"2024-06-21T01:05:22.422Z","dependency_job_id":"811f8e2d-5ddd-41ea-99dc-a4e8d73b5d08","html_url":"https://github.com/wasi-master/rich-rst","commit_stats":{"total_commits":52,"total_committers":4,"mean_commits":13.0,"dds":0.3653846153846154,"last_synced_commit":"acae67044f37b25717487e2c4f88e60ae91d45a0"},"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wasi-master%2Frich-rst","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wasi-master%2Frich-rst/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wasi-master%2Frich-rst/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wasi-master%2Frich-rst/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/wasi-master","download_url":"https://codeload.github.com/wasi-master/rich-rst/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":231810502,"owners_count":18430000,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","command-line-interface","docutils","python","python3","restructuredtext","rich","rst","sphinx"],"created_at":"2024-12-31T15:20:26.511Z","updated_at":"2026-04-05T10:04:13.530Z","avatar_url":"https://github.com/wasi-master.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# rich-rst\n\n[![Documentation Status](https://readthedocs.org/projects/rich-rst/badge/?version=latest)](https://rich-rst.readthedocs.io/en/latest/?badge=latest)\n\nRender [reStructuredText](https://docutils.sourceforge.io/rst.html) with [Rich](https://rich.readthedocs.io/en/latest/). This package turns reST documents into Rich renderables so you can preview documentation, docstrings, and snippets directly in the terminal. Also includes a CLI.\n\n## Highlights\n\n- Supports all currently documented RST elements.\n- Handles common documentation features such as headings, lists, tables, links, images, code blocks, footnotes, and many Sphinx roles.\n- Provides both a Python API and a command-line interface.\n- Can also export rendered output to HTML from the CLI.\n\n## Installation\n\n```sh\npip install rich-rst\n```\n\n## Python API\n\n```python\nfrom rich import print\nfrom rich_rst import RestructuredText\n\ndocument = \"\"\"\nrich-rst\n========\n\nThis is a **test** document.\n\n- Item one\n- Item two\n\n.. code-block:: python\n\n   print(\"hello\")\n\"\"\"\n\nprint(RestructuredText(document))\n```\n\nThe main constructor options are `code_theme`, `show_line_numbers`, `show_errors`, `guess_lexer`, `default_lexer`, and `sphinx_compat`.\n\n## Command Line Interface\n\nRender a file:\n\n```sh\npython -m rich_rst readme.rst\n```\n\nRender from standard input:\n\n```sh\npython -m rich_rst -\n```\n\nView all available options:\n\n```sh\npython -m rich_rst --help\n```\n\nUseful flags include `--code-theme`, `--show-line-numbers`, `--guess-lexer`, `--default-lexer`, `--show-errors`, `--save-html`, `--html-theme`, `--list-html-themes`, `--output`, and `--version`.\n\n## Compatibility\n\nThe renderer is designed for terminal output, so not every docutils feature can be represented visually. The current limitations and unsupported elements are documented in [ELEMENTS.md](ELEMENTS.md).\n\n## Documentation\n\n- [Project documentation](https://rich-rst.readthedocs.io/en/latest/)\n- [Extension API guide](https://rich-rst.readthedocs.io/en/latest/extension_api.html)\n- [Source code](https://github.com/wasi-master/rich-rst)\n- [Issue tracker](https://github.com/wasi-master/rich-rst/issues)\n\n## Changelog\n\nSee [CHANGELOG.md](CHANGELOG.md).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwasi-master%2Frich-rst","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwasi-master%2Frich-rst","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwasi-master%2Frich-rst/lists"}