smoke-wolf/DustyMD

CLI viewer for markdown (md) files.

Markdown Viewer

Markdown Viewer is a Python script that reads a Markdown file and renders it with a formatted appearance using the rich library.

Prerequisites

• Python 3.6 or higher
• rich library (pip install rich)

Installation

1. Clone the repository:

   git clone https://github.com/smoke-wolf/DustyMD.git
   cd repository

Usage

Run the script with Python, providing the path to the Markdown file you want to view.

python md_viewer.py <path_to_markdown_file>

Replace <path_to_markdown_file> with the actual path to your Markdown file.

Example

python md_viewer.py path/to/your/file.md

Features

• Reads Markdown files from the specified path.
• Renders the Markdown content using rich formatting.
• Displays the rendered content inside a bordered panel for clarity.

Dependencies

• rich: For enhanced console output formatting.

License

This project is licensed under the MIT License - see the LICENSE file for details.

---