Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mohammadpagard/markdown-to-png
Python package designed to convert Markdown files into beautifully styled PNG images.
https://github.com/mohammadpagard/markdown-to-png
pypi python-files python-package python3
Last synced: 17 days ago
JSON representation
Python package designed to convert Markdown files into beautifully styled PNG images.
- Host: GitHub
- URL: https://github.com/mohammadpagard/markdown-to-png
- Owner: mohammadpagard
- Created: 2025-01-15T11:57:03.000Z (22 days ago)
- Default Branch: main
- Last Pushed: 2025-01-15T13:06:02.000Z (22 days ago)
- Last Synced: 2025-01-15T13:53:29.401Z (22 days ago)
- Topics: pypi, python-files, python-package, python3
- Language: Python
- Homepage: https://pypi.org/project/markdown-to-png/
- Size: 1000 Bytes
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Markdown To PNG
**markdown-to-png** is a Python package designed to convert Markdown files into beautifully styled PNG images. Whether you want to create visually appealing graphics from text or simply share Markdown content in an image format, this tool has you covered.
This package is designed to be simple to use yet flexible enough to accommodate future enhancements and features.
---
## Features
- Convert Markdown files to PNG images effortlessly.
- Support for custom CSS styling to match your desired visual design.
- Lightweight and easy to integrate into your projects.
---
## Installation
You can install the package using `pip` (once published to PyPI):
```bash
pip install markdown-to-png
```
If you're cloning the repository for development:
```bash
git clone https://github.com/mohammadpagard/markdown-to-png.git
cd markdown-to-png
pip install -e .
```
---
## Usage
Here’s a basic example of how to use the package:
```python
from markdown_to_png import convertor
# convert a markdown file to png
convertor.markdown_to_png("path/to/markdown_file.md", "path/to/output.png")
```
### Optional Parameters
- **CSS File**: Customize the style by specifying a custom CSS file.
```python
convertor.markdown_to_png("path/to/markdown_file.md", "path/to/output.png", css_path="path/to/custom_style.css")
```
---
## Future Plans
This project is a work in progress, and more features are planned for future versions:
- Add support for multiple output formats (e.g., PDF, JPEG).
- Command-line interface for easier use.
- Enhanced error handling and logging.
- Predefined themes for styling.
- Integration with Markdown extensions like tables and footnotes.
Stay tuned for updates!
---
## Contributing
Contributions are welcome! If you have ideas, suggestions, or bug reports, please feel free to open an issue or submit a pull request on [GitHub](https://github.com/mohammadpagard/markdown-to-png).
---
## License
This project is licensed under the [MIT License](LICENSE). You are free to use, modify, and distribute this package as per the terms of the license.
---
## Contact
If you have any questions or feedback, feel free to reach out:
- GitHub: [mohammadpagard](https://github.com/mohammadpagard) (Richie)
- Email: [email protected]