md2all 0.0.4

convertor is a simple and easy to use library for converting markdown files to various formats.

📝 md2all

A minimal Python package to convert Markdown files to clean, responsive HTML with Tailwind CSS, MathJax, and beautiful typography.

Ideal for note-taking, documentation, and publishing markdown content as styled web pages.

---

🚀 Features

• 🧪 Convert .md files into HTML
• 🎨 Built-in support for Tailwind CSS
• 🧮 Renders LaTeX/Math using MathJax
• ✨ Applies prose styling for readability
• 🗂 Outputs to your desired directory

---

Install Dependencies

🛠️ For Debian/Ubuntu:

sudo apt update
sudo apt install -y \
    libavif13 \
    libgstreamer-plugins-base1.0-0 \
    gstreamer1.0-plugins-base \
    gstreamer1.0-plugins-good \
    gstreamer1.0-libav \
    libgstreamer-gl1.0-0 \
    libgstreamer-plugins-bad1.0-0 \
    libgstreamer-plugins-base1.0-dev

---

🛠️ For CentOS/RHEL/Fedora:

sudo dnf install -y \
    gstreamer1-plugins-base \
    gstreamer1-plugins-good \
    gstreamer1-plugins-bad-free \
    gstreamer1-libav \
    libavif

📦 Installation

pip install md2all

Upcoming Features

• 📜 Support for custom CSS
• Support for PDF generation
• Support for custom themes
• Support for custom fonts

How to Use it

Sure! Here's a concise and developer-friendly documentation for using the convert_markdown function as part of your Python library (assuming it's installed from PyPI):

---

📄 convert_markdown

Convert a Markdown (.md) file into a styled HTML file with TailwindCSS and MathJax support.

---

🔧 Function Signature

convert_markdown(md_path: str, output_dir: str = "", output_format: str = "pdf") -> str

---

✨ Features

• Converts .md files to clean, styled HTML
• Supports LaTeX math using $$...$$ (rendered via MathJax)
• Automatically applies Tailwind CSS and custom styling
• Resolves relative paths and saves output to the desired directory

---

📥 Parameters

Name	Type	Description
md_path	str	Path to the input Markdown file. Can be relative or absolute.
output_dir	str	(Optional) Directory to save the converted file. Defaults to input file's directory.
output_format	str	(Optional) Set to "html" to output HTML. Default is "pdf", but PDF is not implemented yet.

---

📤 Returns

• Full path to the converted file.

---

🧪 Example Usage

from md2all import convert_markdown

# Convert a Markdown file to HTML
output_file = convert_markdown("notes/my_math_notes.md", output_dir="output", output_format="html")

print("File saved to:", output_file)

---

📁 Output Structure

• create a .html file to your specified output_dir, if not provided, it will be saved in the same directory as the input file.
• Includes all CSS and MathJax setup in the HTML head section. all css and js library are inside /home/.lib/

---

Author

• Deepak Raj