# 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**
```bash
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.
```bash
pip install -e .
```
3. **Install Dependencies**
Ensure you have the required dependencies. Install them using:
```bash
pip install -r requirements.txt
```
4. **Run and Test**
Use the `mdm` command to test your changes. For example:
```bash
mdm path/to/your/README.md
```
## License
This project is licensed under the MIT License. See the LICENSE file for details.
Raw data
{
"_id": null,
"home_page": "https://github.com/akaashvaa/preview_md_file",
"name": "md-preview022",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": null,
"author": "Akash Verma",
"author_email": "ahmvaad@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/2e/f4/ff7ebaab97e504389214db0e71e89612f70dfaffd09cb50cf877959d5de3/md_preview022-1.0.0.tar.gz",
"platform": null,
"description": "# mdm\n\n`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.\n\n## Development Setup\n\n1. **Clone the Repository**\n\n ```bash\n git clone https://github.com/akaashvaa/preview_md_file.git\n cd mdm\n ```\n\n2. **Install the Package Locally**\n\n Install the package in editable mode. This allows you to make changes to the code and see those changes without reinstalling the package.\n\n ```bash\n pip install -e .\n ```\n\n3. **Install Dependencies**\n\n Ensure you have the required dependencies. Install them using:\n\n ```bash\n pip install -r requirements.txt\n ```\n\n4. **Run and Test**\n\n Use the `mdm` command to test your changes. For example:\n\n ```bash\n mdm path/to/your/README.md\n ```\n\n## License\n\nThis project is licensed under the MIT License. See the LICENSE file for details.\n\n\n\n",
"bugtrack_url": null,
"license": null,
"summary": "A simple Markdown preview tool for the terminal.",
"version": "1.0.0",
"project_urls": {
"Homepage": "https://github.com/akaashvaa/preview_md_file"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "cb0d9cbc03fe8aaeca3914bf82eee844222facac5d77a660a1466e5904c481a2",
"md5": "8b15689f2b3e935ddc6c053bfc847286",
"sha256": "be9f40d7e8c5cfabea3b3a47f655dcf1f41bafa08e2b621cca0523cad2c1bedf"
},
"downloads": -1,
"filename": "md_preview022-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8b15689f2b3e935ddc6c053bfc847286",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 3375,
"upload_time": "2024-08-31T13:23:22",
"upload_time_iso_8601": "2024-08-31T13:23:22.170069Z",
"url": "https://files.pythonhosted.org/packages/cb/0d/9cbc03fe8aaeca3914bf82eee844222facac5d77a660a1466e5904c481a2/md_preview022-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2ef4ff7ebaab97e504389214db0e71e89612f70dfaffd09cb50cf877959d5de3",
"md5": "d81c0761ade15cd007661d47c235e911",
"sha256": "4e13542995ae366a6ac43a7f6e4928fe839c29572f2d2e6775c2f1a2b80718a6"
},
"downloads": -1,
"filename": "md_preview022-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "d81c0761ade15cd007661d47c235e911",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 2867,
"upload_time": "2024-08-31T13:23:23",
"upload_time_iso_8601": "2024-08-31T13:23:23.628140Z",
"url": "https://files.pythonhosted.org/packages/2e/f4/ff7ebaab97e504389214db0e71e89612f70dfaffd09cb50cf877959d5de3/md_preview022-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-31 13:23:23",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "akaashvaa",
"github_project": "preview_md_file",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "md-preview022"
}
JSON
