@udx/md2html 1.2.0 → 1.2.1

package/README.md

@@ -6,9 +6,10 @@ A sophisticated tool for converting markdown files into a single, visually polis
 
 - **Markdown Consolidation**: Intelligently combines and sorts multiple markdown files into a single cohesive document
 - **Magazine-Quality Styling**: Applies high-end editorial styling with precise typography and spacing
-- **Code Block Enhancements**: Syntax highlighting with file type indicators and copy buttons
+- **Code Block Enhancements**: Syntax highlighting with file type indicators
 - **Responsive Images**: Handles high-resolution images with proper sizing and caption support
 - **Watch Mode**: Automatically rebuilds when source files change with intelligent debouncing
+- **Browser Preview**: Live preview server with automatic browser opening
 - **Print Optimization**: Carefully crafted print styling for document printing and PDF generation
 - **Table of Contents**: Auto-generates navigable table of contents from document structure
 - **Customizable**: External CSS, JavaScript, and HTML templates for easy customization
@@ -36,25 +37,33 @@ npm install --save-dev @udx/md2html
 
 ```bash
 # Convert a single markdown file to HTML
-md2html --src path/to/file.md --out output.html
+md2html -s path/to/file.md -o output.html
 
-# Convert all markdown files in a directory
-md2html --src path/to/markdown/dir --out documentation.html
+# Convert all markdown files in a directory  
+md2html -s path/to/markdown/dir -o documentation.html
 
 # Watch for changes and rebuild automatically
-md2html --src path/to/markdown/dir --out documentation.html --watch
+md2html -s path/to/markdown/dir -o documentation.html --watch
+
+# Open in browser with live preview
+md2html -s path/to/file.md --preview
+
+# Custom port for preview server
+md2html -s path/to/markdown/dir --preview --port 3000
 
 # Enable debug output
-md2html --src path/to/markdown/dir --out documentation.html --debug
+md2html -s path/to/markdown/dir -o documentation.html --debug
 ```
 
 ## CLI Options
 
 | Option | Description |
 |--------|-------------|
-| `-s, --src <path>` | Source markdown file or directory (required) |
-| `-o, --out <path>` | Output HTML file path (required) |
+| `-s, --src <file>` | Source markdown file or directory (required) |
+| `-o, --out <file>` | Output HTML file path (optional - defaults to ./output.html) |
 | `-w, --watch` | Watch for changes and rebuild automatically |
+| `-p, --preview` | Open generated HTML in browser with live preview server |
+| `--port <number>` | Port for preview server (default: random) |
 | `-d, --debug` | Enable debug logging |
 | `-h, --help` | Display help information |
 | `-v, --version` | Output the version number |
@@ -101,28 +110,6 @@ Add captions to images with this syntax:
 *This is the image caption*
 ```
 
-### Mermaid Diagrams
-
-Create professional diagrams using Mermaid syntax:
-
-````markdown
-```mermaid
-flowchart LR
-    A[Client] --> B[Load Balancer]
-    B --> C[Server1]
-    B --> D[Server2]
-```
-````
-
-Supported Mermaid diagram types:
-- **Flowcharts**: Process flows and workflows
-- **Sequence Diagrams**: System interactions over time
-- **Gantt Charts**: Project timelines and schedules
-- **Entity Relationship Diagrams**: Database schemas
-- **User Journey**: User experience flows
-- **Git Graphs**: Version control workflows
-
-The diagrams are automatically rendered when the HTML document loads, with professional styling that matches the document theme.
 
 ## Customization
 
@@ -170,17 +157,6 @@ gh repo clone owner/repo
 md2html --src ./repo/docs --out documentation.html
 ```
 
-## Command Line Options
-
-```
-Options:
-  -V, --version         output the version number
-  -s, --src <directory> Source directory containing markdown files
-  -o, --out <file>      Output HTML file path
-  -w, --watch           Watch for changes and rebuild automatically (default: false)
-  -d, --debug           Enable debug logging (default: false)
-  -h, --help            display help for command
-```
 
 ## Output Example
 
@@ -193,19 +169,6 @@ The generated HTML document includes:
 - Print-optimized layout with page breaks
 - Responsive design for various screen sizes
 
-## API Usage
-
-md2html can also be used programmatically:
-
-```javascript
-import { buildHtml, watchMarkdown } from '@udx/md2html';
-
-// Build HTML once
-await buildHtml('/path/to/markdown/dir', 'output.html');
-
-// Watch for changes
-watchMarkdown('/path/to/markdown/dir', 'output.html');
-```
 
 ## Best Practices
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@udx/md2html",
-  "version": "1.2.0",
+  "version": "1.2.1",
   "description": "Magazine-quality Markdown to HTML converter with professional styling",
   "main": "index.js",
   "type": "module",