A modern CLI and web-based viewer for reStructuredText files.
Project description
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.
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:
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
License
This project is licensed under the MIT License. See the LICENSE file for details.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file rst_previewer-0.1.1.tar.gz.
File metadata
- Download URL: rst_previewer-0.1.1.tar.gz
- Upload date:
- Size: 564.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: python-httpx/0.28.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
5c0984a36f08097562d7f074819292843510433e60f3ecd42c206f621b65f3f7
|
|
| MD5 |
944e99e38832d9af51dac4432a9f563e
|
|
| BLAKE2b-256 |
c7df68ab68ce2643018bb49d3b1e3a7e22614ad19d3d6cfd09adf5e6cdfe41b1
|
File details
Details for the file rst_previewer-0.1.1-py3-none-any.whl.
File metadata
- Download URL: rst_previewer-0.1.1-py3-none-any.whl
- Upload date:
- Size: 5.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: python-httpx/0.28.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
7e993d1d344fb12094f4813022f436c62b80f7b56bc527dc5f5774bc8a3716fd
|
|
| MD5 |
e3e278ee439bb8315307c8b9985e55c0
|
|
| BLAKE2b-256 |
548a24b571ffbea969a90bb00014927307ce1ad1a498bda991efbe7cf213ee52
|
