obsidian-plugin/antokeinanen_obsidian-advanced-merger

mirror of https://github.com/antokeinanen/obsidian-advanced-merger.git synced 2026-07-22 07:40:24 +00:00

No description

Find a file

Anto Keinänen 1381e6cfec docs: add 'code of conduct' and 'cotribution' to readme		2023-05-10 17:37:12 +03:00
.github/ISSUE_TEMPLATE	remove actions	2023-05-10 16:24:07 +03:00
.husky	add pre-commit hook to autoformat code	2023-05-05 19:03:05 +03:00
media	add better gif showcasing the functionality	2023-03-29 19:41:16 +03:00
.editorconfig	Initial commit	2023-03-16 18:33:51 +02:00
.eslintignore	Initial commit	2023-03-16 18:33:51 +02:00
.eslintrc	Initial commit	2023-03-16 18:33:51 +02:00
.gitignore	[*] Ignore more temporary dev stuff.	2023-05-03 08:26:52 +00:00
.npmrc	Initial commit	2023-03-16 18:33:51 +02:00
CHANGELOG.md	[+] Added changelog.	2023-05-10 08:52:10 +00:00
esbuild.config.mjs	[*] Utilize pretty-quick.	2023-05-09 07:28:08 +00:00
LICENSE	added a license	2023-03-16 19:30:11 +02:00
main.ts	fix bug: translation fallback was unreachable	2023-05-10 15:36:02 +03:00
manifest.json	[*] Bump version and authors info.	2023-05-10 08:30:50 +00:00
package-lock.json	add pre-commit hook to autoformat code	2023-05-05 19:03:05 +03:00
package.json	[+] Added changelog.	2023-05-10 08:52:10 +00:00
README.md	docs: add 'code of conduct' and 'cotribution' to readme	2023-05-10 17:37:12 +03:00
tsconfig.json	Initial commit	2023-03-16 18:33:51 +02:00
version-bump.mjs	Initial commit	2023-03-16 18:33:51 +02:00
versions.json	Initial commit	2023-03-16 18:33:51 +02:00

README.md

Obsidian Advanced Merge

Merge a folder of notes for easier export. This plugin is designed for obsidian app.

Preview of the plugin. Image by Nuno Campos

Installation

Installation through Obsidian community marketplace

This plugin can now be installed inside obsidian in the community plugins tab. Link

Go to obsidian settings panel.
Open community plugins tab.
Browse community plugins.
Search Advanced Merger.
Install and enable the plugin.

Manual installation

Download the latest release from releases page.
Extract the zip archive.
Move the 2 files (manifest.json, and main.js) to <your obsidian vault folder>/.obsidian/plugins/obsidian-advanced-merger
Start obsidian, go to settings>community plugins, and turn Advanced merger on.

Usage

Using Advanced merge is very easy! Just right click a folder and select merge folder.

Contributing

To build and test this repository it is adviced 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 contribuitons are welcome, but before making anything big please concider starting a discussion in the issues tab.

Code of conduct

Make sure your code is formatted.
Use angular commit message style. More info here.

Commit message format

This specification is inspired by and supersedes the AngularJS commit message format.

This format leads to easier to read commit history. All commit messages must comform to this format:

<header>
<BLANK LINE>
<body>

Commit Header

The type field is always required. Summary is optional when bumping version. Every commit should only contain one type.

<type>: <short summary>
  │           │
  │           └─⫸ Summary in present tense. Not capitalized. No period at the end.
  │
  │
  └─⫸ Commit Type: build|docs|feat|fix|perf|refactor|test

Type

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

Support

You can support me by buying me a coffee at buymeacoffee.com!