antokeinanen_obsidian-advan.../README.md

# Obsidian Advanced Merge
Merge a folder of notes for easier export. This plugin is designed for the [obsidian](https://obsidian.md/) app.

![preview](https://github.com/antoKeinanen/obsidian-advanced-merger/blob/master/media/1%200Ghz5j7MB_oKJdxoIc5-lg.gif?raw=true)
<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).
## 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|perf|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)!
Initial commit Changes to be committed: new file: .editorconfig new file: .eslintignore new file: .eslintrc new file: .gitignore new file: .npmrc new file: README.md new file: esbuild.config.mjs new file: main.ts new file: manifest.json new file: media/2023-03-16 18-23-14.gif new file: package-lock.json new file: package.json new file: styles.css new file: tsconfig.json new file: version-bump.mjs new file: versions.json 2023-03-16 16:33:51 +00:00			`# Obsidian Advanced Merge`
docs: fix spelling 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.`
created readme.md 2023-03-16 17:19:24 +00:00
update readme.md to have better gif 2023-03-29 16:45:49 +00:00			`![preview](https://github.com/antoKeinanen/obsidian-advanced-merger/blob/master/media/1%200Ghz5j7MB_oKJdxoIc5-lg.gif?raw=true)`
			`<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>`
created readme.md 2023-03-16 17:19:24 +00:00
reformat readme.md headers 2023-05-10 13:40:19 +00:00			`# Installation`
			`## Installation through Obsidian community marketplace`
docs: fix spelling 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)`
			`1. Go to the Obsidian settings panel.`
			`2. Open the community plugins tab.`
update readme.md to reflect the ability to install via community plugins 2023-05-09 07:23:57 +00:00			`3. Browse community plugins.`
			4. Search `Advanced Merger`.
			`5. Install and enable the plugin.`
created readme.md 2023-03-16 17:19:24 +00:00
reformat readme.md headers 2023-05-10 13:40:19 +00:00			`## Manual installation`
created readme.md 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`
docs: fix spelling 2023-05-10 14:39:26 +00:00			4. Start Obsidian, go to settings>community plugins, and turn `Advanced merger` on.
created readme.md 2023-03-16 17:19:24 +00:00
reformat readme.md headers 2023-05-10 13:40:19 +00:00			`# Usage`
docs: fix spelling 2023-05-10 14:39:26 +00:00			Using Advanced merger is very easy! Just right-click a folder and select `merge folder`.
created readme.md 2023-03-16 17:19:24 +00:00
docs: add 'code of conduct' and 'cotribution' to readme 2023-05-10 14:37:12 +00:00			`# Contributing`
docs: fix spelling 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.
docs: add 'code of conduct' and 'cotribution' to readme 2023-05-10 14:37:12 +00:00
docs: fix spelling 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.`
docs: add 'code of conduct' and 'cotribution' to readme 2023-05-10 14:37:12 +00:00
			`# Code of conduct`
docs: define format command 2023-05-10 14:50:04 +00:00			- Make sure your code is formatted with the `npm/yarn run format` script.
docs: add 'code of conduct' and 'cotribution' to readme 2023-05-10 14:37:12 +00:00			`- Use angular commit message style. More info [here](https://github.com/antoKeinanen/obsidian-advanced-merger#commit-message-format).`
			`## 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)`

docs: fix spelling 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:`
docs: add 'code of conduct' and 'cotribution' to readme 2023-05-10 14:37:12 +00:00			```
			`<header>`
			`<BLANK LINE>`
			`<body>`
			```
			`## Commit Header`
docs: include examples of commit header, itroduce issue id, and specify message body 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.`
docs: add 'code of conduct' and 'cotribution' to readme 2023-05-10 14:37:12 +00:00			```
docs: include examples of commit header, itroduce issue id, and specify message body 2023-05-10 14:47:09 +00:00			`<type>(<issue-id>): <short summary>`
docs: add 'code of conduct' and 'cotribution' to readme 2023-05-10 14:37:12 +00:00			`│ │`
docs: fix spelling 2023-05-10 14:39:26 +00:00			`│ └─⫸ Summary in the present tense. Not capitalized. No period at the end.`
docs: add 'code of conduct' and 'cotribution' to readme 2023-05-10 14:37:12 +00:00			`│`
			`│`
			`└─⫸ Commit Type: build\|docs\|feat\|fix\|perf\|refactor\|test`
			```
			`### Type`
docs: include examples of commit header, itroduce issue id, and specify message body 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`
docs: add 'code of conduct' and 'cotribution' to readme 2023-05-10 14:37:12 +00:00			`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`

docs: include examples of commit header, itroduce issue id, and specify message body 2023-05-10 14:47:09 +00:00			`## Message body`
			`- Optional but recommended`
			`- Just as in <subject> use imperative, present tense: “change” not “changed” nor “changes”`


docs: add 'code of conduct' and 'cotribution' to readme 2023-05-10 14:37:12 +00:00
reformat readme.md headers 2023-05-10 13:40:19 +00:00			`# Support`
created readme.md 2023-03-16 17:19:24 +00:00			`You can support me by buying me a coffee at [buymeacoffee.com](https://www.buymeacoffee.com/antokeinanen)!`