Metadata-Version: 2.4
Name: rst-previewer
Version: 0.1.1
Summary: A modern CLI and web-based viewer for reStructuredText files.
Project-URL: Bug Tracker, https://github.com/rohanmohapatra/rst-previewer/issues
Project-URL: Homepage, https://github.com/rohanmohapatra/rst-previewer
Author-email: rohanmohapatra <rohanironcrest14@gmail.com>
License-File: LICENSE
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Text Editors :: Documentation
Classifier: Topic :: Utilities
Requires-Python: >=3.10
Requires-Dist: docutils>=0.21
Requires-Dist: gradio>=4.0.0
Requires-Dist: termcolor>=2.4.0
Requires-Dist: typer[all]>=0.9.0
Description-Content-Type: text/markdown

# rst-previewer

A modern CLI tool that finds reStructuredText (.rst) files in a directory and displays them in a clean, web-based Gradio interface. Perfect for quickly previewing documentation, articles, or notes without a full Sphinx build.

<img src="https://raw.githubusercontent.com/rohanmohapatra/rst-previewer/main/docs/images/hero.png">

## Installation
This tool is designed to be installed and run in an isolated environment using pipx. This avoids cluttering your global Python installation.

#### Install rst-previewer:
```sh
pipx install rst-previewer
```

That's it! The `rst-previewer` command is now available anywhere in your terminal.

## Usage

#### Select a file from a directory:
```
rst-previewer /path/to/your/project/docs/
```
The tool will print a local URL to your terminal. Open this URL in your web browser to see the rendered document.

## Development Guide

Interested in contributing? Setting up a development environment is easy.

#### Prerequisites
- Git
- Python 3.10+
- [uv](https://github.com/astral-sh/uv) 

## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.