mirror of
https://github.com/antokeinanen/obsidian-advanced-merger.git
synced 2026-07-22 07:40:24 +00:00
99 lines
3.8 KiB
Markdown
99 lines
3.8 KiB
Markdown
# Obsidian Advanced Merge
|
|
|
|
Merge a folder of notes for easier export. This plugin is designed for the [obsidian](https://obsidian.md/) app.
|
|
|
|
|
|
|
|
<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>
|
|
|
|
# Installation
|
|
|
|
## Installation through Obsidian community marketplace
|
|
|
|
This plugin can now be installed inside Obsidian in the community plugins tab. [Link](obsidian://show-plugin?id=advanced-merger)
|
|
|
|
1. Go to the Obsidian settings panel.
|
|
2. Open the community plugins tab.
|
|
3. Browse community plugins.
|
|
4. Search `Advanced Merger`.
|
|
5. Install and enable the plugin.
|
|
|
|
## Manual installation
|
|
|
|
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`
|
|
4. Start Obsidian, go to settings>community plugins, and turn `Advanced merger` on.
|
|
|
|
# Usage
|
|
|
|
Using Advanced merger is very easy! Just right-click a folder and select `merge folder`.
|
|
|
|
# Contributing
|
|
|
|
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.
|
|
|
|
All contributions are welcome, but before making anything big please consider starting a discussion in the issues tab.
|
|
|
|
# Code of conduct
|
|
|
|
- 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`.
|
|
|
|
## Commit message format
|
|
|
|
_This specification is inspired by and supersedes the [AngularJS commit message format.](https://github.com/angular/angular/blob/main/CONTRIBUTING.md#commit)_
|
|
|
|
This format leads to easier-to-read commit history.
|
|
All commit messages must conform to this format:
|
|
|
|
```
|
|
<header>
|
|
<BLANK LINE>
|
|
<body>
|
|
```
|
|
|
|
## Commit Header
|
|
|
|
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.
|
|
|
|
```
|
|
<type>(<issue-id>): <short summary>
|
|
│ │
|
|
│ └─⫸ Summary in the present tense. Not capitalized. No period at the end.
|
|
│
|
|
└─⫸ Commit Type: build|docs|feat|fix|refactor|test
|
|
```
|
|
|
|
### Type
|
|
|
|
**Example**: `fix(#123): fix a bug where XYZ`, `bump-version`, `feat(#123): add a feature that XYZ`
|
|
Must be one of the following:
|
|
|
|
- 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
|
|
|
|
## Summary
|
|
|
|
Use the summary field to provide a succinct description of the change:
|
|
|
|
- use the imperative, present tense: "change" not "changed" nor "changes"
|
|
- don't capitalize the first letter
|
|
- no dot (.) at the end
|
|
|
|
## Message body
|
|
|
|
- Optional but recommended
|
|
- Just as in <subject> use imperative, present tense: “change” not “changed” nor “changes”
|
|
|
|
# Support
|
|
|
|
You can support me by buying me a coffee at [buymeacoffee.com](https://www.buymeacoffee.com/antokeinanen)!
|