README file from
Github.md Merge
.md Merge is an Obsidian plugin that allows you to merge multiple Markdown files from a folder (and optionally its subfolders) into a single consolidated file.
Features
-
Merge all
.mdfiles from a specified folder -
Optional recursive mode to include subfolders
-
Customize the output file name using templates like
{date} -
Exclude specific files or patterns using glob syntax (e.g.,
README.md,drafts/*.md) -
Optionally include or exclude hidden files
-
Create output folders automatically if they don't exist
-
Access functionality via:
- Sidebar ribbon button
- Command palette
- Hotkey
Installation
-
Download or clone this repository.
-
Place the plugin folder inside
.obsidian/plugins/of your vault. -
Run
npm installto install dependencies. -
Build the plugin with:
npm run build -
Enable the plugin from Obsidian’s Settings → Community Plugins.
Settings
- Source folder: Path relative to vault root; leave blank to merge from root.
- Output folder: Where the merged file is saved; defaults to
/merged - Output file name: Template name, supports
{date} - Include hidden files: Include files that begin with a
. - Recursive mode: Include files from subfolders.
- Excluded files: Glob patterns to ignore (comma-separated).
Commands
- Merge Markdown Files: Available in the command palette. Can also be triggered via hotkey.
Notes
- Output file is overwritten on each merge.
- Input files must have the
.mdextension. - Output folder and file are created if they don't exist.
License
GNU General Public License v3.0