2023-03-16 16:33:51 +00:00
# Obsidian Advanced Merge
2023-05-19 13:08:33 +00:00
2023-05-10 14:39:26 +00:00
Merge a folder of notes for easier export. This plugin is designed for the [obsidian ](https://obsidian.md/ ) app.
2023-03-16 17:19:24 +00:00
2023-03-29 16:45:49 +00:00
2023-05-19 13:08:33 +00:00
2023-03-29 16:45:49 +00:00
< p align = "center" >
Preview of the plugin. Image by
< a href = "https://medium.com/technology-hits/obsidian-plugins-review-14-20d087f0e23a" > Nuno Campos< / a >
< / p >
2023-03-16 17:19:24 +00:00
2023-05-10 13:40:19 +00:00
# Installation
2023-05-19 13:08:33 +00:00
2023-05-10 13:40:19 +00:00
## Installation through Obsidian community marketplace
2023-05-19 13:08:33 +00:00
2023-05-10 14:39:26 +00:00
This plugin can now be installed inside Obsidian in the community plugins tab. [Link ](obsidian://show-plugin?id=advanced-merger )
2023-05-19 13:08:33 +00:00
2023-05-10 14:39:26 +00:00
1. Go to the Obsidian settings panel.
2. Open the community plugins tab.
2023-05-09 07:23:57 +00:00
3. Browse community plugins.
4. Search `Advanced Merger` .
5. Install and enable the plugin.
2023-03-16 17:19:24 +00:00
2023-05-10 13:40:19 +00:00
## Manual installation
2023-05-19 13:08:33 +00:00
2023-03-16 17:19:24 +00:00
1. Download the latest release from [releases page ](https://github.com/antoKeinanen/obsidian-advanced-merger/releases ).
2. Extract the zip archive.
3. Move the 2 files (`manifest.json`, and `main.js` ) to `<your obsidian vault folder>/.obsidian/plugins/obsidian-advanced-merger`
2023-05-10 14:39:26 +00:00
4. Start Obsidian, go to settings>community plugins, and turn `Advanced merger` on.
2023-03-16 17:19:24 +00:00
2023-05-10 13:40:19 +00:00
# Usage
2023-05-19 13:08:33 +00:00
2023-05-10 14:39:26 +00:00
Using Advanced merger is very easy! Just right-click a folder and select `merge folder` .
2023-03-16 17:19:24 +00:00
2023-05-10 14:37:12 +00:00
# Contributing
2023-05-19 13:08:33 +00:00
2023-05-10 14:39:26 +00:00
To build and test this repository it is advised to create a new vault. Clone this repository to `<your obsidian vault folder>/.obsidian/plugins/` and run `yarn install` and `yarn build` or `npm install` and `npm build` inside of is. Then in Obsidian toggle the plugin on and off to refresh it.
2023-05-10 14:37:12 +00:00
2023-05-10 14:39:26 +00:00
All contributions are welcome, but before making anything big please consider starting a discussion in the issues tab.
2023-05-10 14:37:12 +00:00
# Code of conduct
2023-05-19 13:08:33 +00:00
2025-03-27 18:10:56 +00:00
- Make sure your code is formatted with the `npm/yarn run format` script.
- Use angular commit message style. More info [here ](https://github.com/antoKeinanen/obsidian-advanced-merger#commit-message-format ).
- Please _DO NOT_ modify `manifest.json` as it breaks the plugin download system. For beta release use [BRAT ](https://tfthacker.com/Obsidian+Plugins+by+TfTHacker/BRAT+-+Beta+Reviewer's+Auto-update+Tool/Quick+guide+for+using+BRAT#Testing+Plugins ) and version bump `manifest-beta.json` .
2023-05-19 13:08:33 +00:00
2023-05-10 14:37:12 +00:00
## Commit message format
2023-05-19 13:08:33 +00:00
_This specification is inspired by and supersedes the [AngularJS commit message format. ](https://github.com/angular/angular/blob/main/CONTRIBUTING.md#commit )_
2023-05-10 14:37:12 +00:00
2023-05-10 14:39:26 +00:00
This format leads to easier-to-read commit history.
All commit messages must conform to this format:
2023-05-19 13:08:33 +00:00
2023-05-10 14:37:12 +00:00
```
< header >
< BLANK LINE >
< body >
```
2023-05-19 13:08:33 +00:00
2023-05-10 14:37:12 +00:00
## Commit Header
2023-05-19 13:08:33 +00:00
2023-05-10 14:47:09 +00:00
The type field is always required. A summary is optional when bumping the version. If the commit is related to issue please refer to it. Every commit should only contain one type.
2023-05-19 13:08:33 +00:00
2023-05-10 14:37:12 +00:00
```
2023-05-10 14:47:09 +00:00
< type > (< issue-id > ): < short summary >
2023-05-19 13:08:33 +00:00
│ │
│ └─⫸ Summary in the present tense. Not capitalized. No period at the end.
2023-05-10 14:37:12 +00:00
│
2023-05-19 13:08:33 +00:00
└─⫸ Commit Type: build|docs|feat|fix|refactor|test
2023-05-10 14:37:12 +00:00
```
2023-05-19 13:08:33 +00:00
2023-05-10 14:37:12 +00:00
### Type
2023-05-19 13:08:33 +00:00
2023-05-10 14:47:09 +00:00
**Example**: `fix(#123): fix a bug where XYZ` , `bump-version` , `feat(#123): add a feature that XYZ`
2023-05-10 14:37:12 +00:00
Must be one of the following:
2023-05-19 13:08:33 +00:00
2025-03-27 18:10:56 +00:00
- build: Changes that affect the build system or external dependencies
- docs: Documentation only changes
- feat: A new feature
- fix: A bug fix
- refactor: A code change that neither fixes a bug nor adds a feature
- test: Adding new tests or correcting existing tests
2023-05-10 14:37:12 +00:00
## Summary
2023-05-19 13:08:33 +00:00
2023-05-10 14:37:12 +00:00
Use the summary field to provide a succinct description of the change:
2025-03-27 18:10:56 +00:00
- use the imperative, present tense: "change" not "changed" nor "changes"
- don't capitalize the first letter
- no dot (.) at the end
2023-05-10 14:47:09 +00:00
2023-05-19 13:08:33 +00:00
## Message body
2023-05-10 14:47:09 +00:00
2025-03-27 18:10:56 +00:00
- Optional but recommended
- Just as in < subject > use imperative, present tense: “change” not “changed” nor “changes”
2023-05-10 14:37:12 +00:00
2023-05-10 13:40:19 +00:00
# Support
2023-05-19 13:08:33 +00:00
You can support me by buying me a coffee at [buymeacoffee.com ](https://www.buymeacoffee.com/antokeinanen )!
