Skip to main content

A simple Markdown preview tool for the terminal.

Project description

mdm

mdm is a simple Markdown preview tool for the terminal. It allows you to quickly view the content of Markdown files directly in your terminal with formatted output.

Development Setup

  1. Clone the Repository

    git clone https://github.com/akaashvaa/preview_md_file.git
    cd mdm
    
  2. Install the Package Locally

    Install the package in editable mode. This allows you to make changes to the code and see those changes without reinstalling the package.

    pip install -e .
    
  3. Install Dependencies

    Ensure you have the required dependencies. Install them using:

    pip install -r requirements.txt
    
  4. Run and Test

    Use the mdm command to test your changes. For example:

    mdm path/to/your/README.md
    

License

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

md_preview022-1.0.0.tar.gz (2.9 kB view hashes)

Uploaded Source

Built Distribution

md_preview022-1.0.0-py3-none-any.whl (3.4 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page