Add example configurations and sample files for treefmt and dprint integrations

Co-authored-by: neongreen <1523306+neongreen@users.noreply.github.com>

Author: Copilot

markdown-format/README.md

@@ -61,6 +61,8 @@ Let's format it!
 
 ## Integration with Formatting Tools
 
+See the [examples/](examples/) directory for complete configuration files and sample markdown files demonstrating the integrations.
+
 ### treefmt
 
 [treefmt](https://github.com/numtide/treefmt) is a universal code formatter that runs multiple formatters with one command.

markdown-format/examples/README.md

@@ -0,0 +1,37 @@
+# Integration Examples
+
+This directory contains example configurations and files for integrating markdown-format with various formatting tools.
+
+## Files
+
+- `treefmt.toml` - Example configuration for treefmt
+- `markdown-format-inplace.sh` - Wrapper script for treefmt integration (makes markdown-format work in-place)
+- `dprint.json` - Example configuration for dprint
+- `sample-input.md` - Sample markdown file before formatting
+- `sample-output.md` - Sample markdown file after formatting with markdown-format
+
+## Testing the Integration
+
+### With treefmt
+
+1. Install treefmt (https://github.com/numtide/treefmt)
+2. Copy `treefmt.toml` and `markdown-format-inplace.sh` to your project root
+3. Update the path in `markdown-format-inplace.sh` to point to your markdown-format binary
+4. Run `treefmt` to format all markdown files
+
+### With dprint
+
+1. Install dprint (https://dprint.dev/)
+2. Copy `dprint.json` to your project root
+3. Update the command path to point to your markdown-format binary
+4. Run `dprint fmt` to format all markdown files
+
+## Verifying the Integration
+
+You can test the integration by:
+
+1. Creating a copy of `sample-input.md` in your project
+2. Running your formatter (treefmt or dprint)
+3. Comparing the result with `sample-output.md`
+
+The output should match, with one sentence per line while preserving all markdown structure.

markdown-format/examples/dprint.json

@@ -0,0 +1,15 @@
+{
+  "$schema": "https://dprint.dev/schemas/v0.json",
+  "exec": {
+    "commands": [{
+      "command": "./markdown-format/markdown-format {{file_path}}",
+      "exts": ["md"]
+    }]
+  },
+  "plugins": [],
+  "excludes": [
+    "**/*-lock.json",
+    "**/node_modules",
+    "**/.git"
+  ]
+}

markdown-format/examples/markdown-format-inplace.sh

@@ -0,0 +1,17 @@
+#!/bin/bash
+# Wrapper script to make markdown-format work in-place for treefmt
+# This script takes file paths as arguments and formats them in place
+
+# Adjust this path to where your markdown-format binary is located
+MARKDOWN_FORMAT="./markdown-format/markdown-format"
+
+for file in "$@"; do
+    if [ -f "$file" ]; then
+        # Create a temporary file
+        temp_file=$(mktemp)
+        # Format the file and save to temp
+        "$MARKDOWN_FORMAT" "$file" > "$temp_file"
+        # Replace original file with formatted content
+        mv "$temp_file" "$file"
+    fi
+done

markdown-format/examples/sample-input.md

@@ -0,0 +1,18 @@
+# Sample Document
+
+This is a paragraph with multiple sentences. It should be formatted with one sentence per line. This makes git diffs easier to read.
+
+## Features
+
+- First item with a long description. This has multiple sentences.
+- Second item
+- Third item with more text. And even more!
+
+## Code Example
+
+```python
+def hello():
+    print("Hello, world!")
+```
+
+Conclusion paragraph. Final thoughts here. That's all!

markdown-format/examples/sample-output.md

@@ -0,0 +1,24 @@
+# Sample Document
+
+This is a paragraph with multiple sentences.
+It should be formatted with one sentence per line.
+This makes git diffs easier to read.
+
+## Features
+
+- First item with a long description.
+  This has multiple sentences.
+- Second item
+- Third item with more text.
+  And even more!
+
+## Code Example
+
+```python
+def hello():
+    print("Hello, world!")
+```
+
+Conclusion paragraph.
+Final thoughts here.
+That's all!

markdown-format/examples/treefmt.toml

@@ -0,0 +1,12 @@
+# Example treefmt configuration for markdown-format
+# Place this file in your project root as treefmt.toml
+
+[formatter.markdown-format]
+# Path to the wrapper script that formats files in-place
+command = "./markdown-format-inplace.sh"
+# No additional options needed
+options = []
+# Format all markdown files
+includes = ["*.md"]
+# Optionally exclude certain files
+excludes = []