mike/folder-combiner
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
No description
18 commits 1 branch 0 tags 72 KiB
Find a file
Exact
Mike Bros cef1be8d7a Fix recursive subfolder content and improve combined file format 
- Include content from subfolders when combining (was only showing in directory tree)
- Add filename as main header with path metadata below each file section
- Add unique identifier to exclude previously combined files from future combinations

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2026-02-07 10:38:22 -06:00
.github/workflows Add release workflow 2024-12-13 14:45:17 -06:00
.editorconfig Init commit for folder combiner 2024-12-06 09:14:22 -06:00
.eslintignore Init commit for folder combiner 2024-12-06 09:14:22 -06:00
.eslintrc Init commit for folder combiner 2024-12-06 09:14:22 -06:00
.gitignore Init commit for folder combiner 2024-12-06 09:14:22 -06:00
.npmrc Init commit for folder combiner 2024-12-06 09:14:22 -06:00
esbuild.config.mjs Init commit for folder combiner 2024-12-06 09:14:22 -06:00
LICENSE Initial commit 2024-12-06 09:15:40 -06:00
main.ts Fix recursive subfolder content and improve combined file format 2026-02-07 10:38:22 -06:00
manifest.json 1.3.0 2025-01-05 13:56:19 -06:00
package-lock.json 1.3.0 2025-01-05 13:56:19 -06:00
package.json 1.3.0 2025-01-05 13:56:19 -06:00
README.md Removing changelog from readme for easier maintence of versions with npm and releases. 2025-01-05 13:56:04 -06:00
styles.css Init commit for folder combiner 2024-12-06 09:14:22 -06:00
tsconfig.json Init commit for folder combiner 2024-12-06 09:14:22 -06:00
version-bump.mjs Init commit for folder combiner 2024-12-06 09:14:22 -06:00
versions.json 1.3.0 2025-01-05 13:56:19 -06:00

README.md

Folder Markdown Combiner

An Obsidian plugin that allows you to combine markdown files, either from a specific folder or across your entire vault.

Features

  • Right-click on a folder to combine all markdown files within that folder
  • Use the ribbon icon or command palette to combine all markdown files from your entire vault
  • Option to include directory structure context in combined files
  • Flexible filename suffix options:
    • Timestamp with customizable Moment.js format
    • Random string generation with configurable length and character set
  • Toggle the ribbon icon visibility in settings
  • Creates a new markdown file with contents from all files
  • Preserves original file names/paths as headers
  • Adds a separator between combined files
  • Automatically sorts files for consistent output

Installation

Manual Installation

  1. Download the latest release from the Releases page
  2. Extract the files into your vault's plugins folder: VaultFolder/.obsidian/plugins/folder-file-combiner/
  3. Enable the plugin in Obsidian settings

Usage

Combining Files in a Specific Folder

  1. Right-click on any folder in Obsidian
  2. Select "Combine Markdown Files"
  3. A new file will be created in that folder with a name based on your suffix settings

Combining All Vault Files

You have two options:

  1. Click the ribbon icon (file stack) in the left sidebar
  2. Use the command palette (Ctrl/Cmd + P) and search for "Combine All Markdown Files"

The combined vault file will be created in your vault root with a name based on your suffix settings

Settings

You can configure the plugin in Settings > Folder File Combiner:

  • Toggle the ribbon icon visibility
  • Include directory structure context in combined files
  • Choose filename suffix style:
    • Timestamp: Customize format using Moment.js patterns (e.g., YYYY-MM-DD-HH-mm-ss)
    • Random: Configure length and character set for random string generation
  • Live preview of timestamp format

Development

Requirements:

  • Node.js
  • npm

Setup:

  1. Clone this repository
  2. npm install
  3. npm run dev for development builds
  4. npm run build for production builds

License

MIT