A tool to merge multiple Markdown files.
Project description
Markdown Merger (md-merge)
A command-line tool to merge multiple Markdown files into a single document.
Installation
uv pip install md-merge
CLI
You can also install it using the uv tool, and run it directly from the command line:
uv tool install md-merge
md-merge --help
Usage
# Merge specific files in order
md-merge file1.md another/file.md docs/intro.md --output combined_manual.md
# Merge all *.md files recursively from a directory (alphabetical order)
md-merge --dir path/to/markdown/docs --output full_docs.md
# Specify a different output file
md-merge file.md --output my_merged_file.md
# Enable verbose logging for debugging
mdmerge --dir my_project --verbose
# Get help
md-merge --help
## Features
- Merges specified files or all .md files in a directory.
- Inserts a separator between files showing the source path.
- Adds a header to the merged document with timestamp and file count.
- Preserves YAML front matter (from the first file only).
- Configurable output file path (default: merged.md).
- Verbose logging option (--verbose or -v).
- Robust error handling and validation.
## Future Improvements
- markdown formatting (mdformat)
- Add support for custom separators.
- Implement a GUI for easier file selection.
- Support for other file formats (e.g., .txt, .rst).
- Add unit tests for better coverage.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
md_merge-0.1.0.tar.gz
(8.3 kB
view details)
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file md_merge-0.1.0.tar.gz.
File metadata
- Download URL: md_merge-0.1.0.tar.gz
- Upload date:
- Size: 8.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.4.28
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
44d1c8fc816103e2b7cccb8129e761050ed08a4e4bee2095a85c5299ebe1835c
|
|
| MD5 |
9f19b9779ae609c3338e76bcee50b776
|
|
| BLAKE2b-256 |
0980b13cef796781fc38e56d2a794c2485e8f1b845383c63bfb4b22c5d9fe762
|
File details
Details for the file md_merge-0.1.0-py3-none-any.whl.
File metadata
- Download URL: md_merge-0.1.0-py3-none-any.whl
- Upload date:
- Size: 8.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.4.28
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
35679e03cb0a6c41be6b61180473994269739ec4a8ec3414a4aa3ec601312538
|
|
| MD5 |
93d0a0120573ef26c2bedccc21c5729c
|
|
| BLAKE2b-256 |
66de2df79b30dd6810f768a2ad5383b2cbbc3ea32cecacd2ef5ccc76ee5179bf
|