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 details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

Details for the file md_preview022-1.0.0.tar.gz.

File metadata

  • Download URL: md_preview022-1.0.0.tar.gz
  • Upload date:
  • Size: 2.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.10.12

File hashes

Hashes for md_preview022-1.0.0.tar.gz
Algorithm Hash digest
SHA256 4e13542995ae366a6ac43a7f6e4928fe839c29572f2d2e6775c2f1a2b80718a6
MD5 d81c0761ade15cd007661d47c235e911
BLAKE2b-256 2ef4ff7ebaab97e504389214db0e71e89612f70dfaffd09cb50cf877959d5de3

See more details on using hashes here.

File details

Details for the file md_preview022-1.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for md_preview022-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 be9f40d7e8c5cfabea3b3a47f655dcf1f41bafa08e2b621cca0523cad2c1bedf
MD5 8b15689f2b3e935ddc6c053bfc847286
BLAKE2b-256 cb0d9cbc03fe8aaeca3914bf82eee844222facac5d77a660a1466e5904c481a2

See more details on using hashes here.

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