Skip to content

preview_md_file (mdm) is a simple command-line tool for previewing Markdown files directly in the terminal.

License

Notifications You must be signed in to change notification settings

akaashvaa/preview_md_file

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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.

Installation

  • You can install md_preview022 using pip:
pip install md_preview022
  • example :
   mdm path/to/your/README.md

Development Setup

  1. Clone the Repository

    git clone https://github.com/akaashvaa/preview_md_file.git
    cd preview_md_file
  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.

About

preview_md_file (mdm) is a simple command-line tool for previewing Markdown files directly in the terminal.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages