Update README with usage documentation for convert_markdown function and refactor related code

Author: codeperfectplus

README.md

@@ -33,3 +33,73 @@ pip install md2all
 - 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
+
+```python
+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
+
+```python
+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

md2all/__init__.py

@@ -1,5 +1,5 @@
-from md2all.md_to_html import transform
+from md2all.md_to_html import convert_markdown
 
 __all__ = [
-    "transform",
+    "convert_markdown",
 ]

md2all/md_to_html.py

@@ -48,8 +48,6 @@ def setup_tailwind():
     dst_path = copy_file(source_tailwind_path)
     return dst_path
 
-from bs4 import BeautifulSoup
-
 def modify_classes(html_content):
     """Modify HTML content by injecting Tailwind classes into elements using BeautifulSoup."""
     soup = BeautifulSoup(html_content, 'html.parser')
@@ -86,12 +84,7 @@ def read_markdown_file(file_path):
     with open(file_path, "r", encoding="utf-8", errors="ignore") as f:
         return f.read()
 
-import os
-import shutil
-from pathlib import Path
-import markdown
-
-def transform(md_path, output_dir="", output_format="pdf"):
+def convert_markdown(md_path, output_dir="", output_format="pdf"):
     """Convert Markdown to HTML (optionally PDF), save results in appropriate location."""
     # get full path if not absolute
     if not os.path.isabs(md_path):
@@ -138,15 +131,15 @@ def transform(md_path, output_dir="", output_format="pdf"):
         f.write(html_template)
 
     # If output format is .html, copy to output directory
-    if output_format == ".html":
+    if output_format == "html":
         if output_dir:
             setup_directory(output_dir)
             shutil.copy(temp_html_path, final_output_path)
         else:
             shutil.copy(temp_html_path, final_output_path)
 
     # If output format is .pdf, delegate to PDF converter
-    elif output_format == ".pdf":
+    elif output_format == "pdf":
         if output_dir:
             setup_directory(output_dir)
         # Here, you'd use `temp_html_path` for PDF conversion

setup.py

@@ -12,7 +12,7 @@
 # Setting up the package
 setuptools.setup(
     name="md2all",
-    version="0.0.2",
+    version="0.0.3",
     author="Deepak Raj",
     author_email="deepak008@live.com",
     description="convertor is a simple and easy to use library for converting markdown files to various formats.",