diff --git a/README.md b/README.md index 7ffe49355136eed87c648855a09a30b69e9a90fe..65eb642b0bca97daa94d16826d8b79563559fc1f 100644 --- a/README.md +++ b/README.md @@ -37,9 +37,20 @@ t --> s ### Git sync plugin in Obsidian This text has been commited and pushed via the Obsidian git plugin. Keep in mind that on windows, this can only be done if the repository is cloned via HTTPS, not SSH cert. +This is what a conflict looks like: +``` +<<<<<<< HEAD This text is changed via Obsidian. At the same time, there is a change online. +======= +This text is added online. At the same time, there is a change in Obsidian. +>>>>>>> origin/main +``` +When you pull and there are merge conflicts, the plugin will open an overview page with all the conflicts listed. You can correct them, then you should push all changes immediately. The overview page may look like [this](example_conflict-files-obsidian-git.md). --- + +There may also be non-conflicting changes, such as this. + ## Getting started To make it easy for you to get started with GitLab, here's a list of recommended next steps. diff --git a/example_conflict-files-obsidian-git.md b/example_conflict-files-obsidian-git.md new file mode 100644 index 0000000000000000000000000000000000000000..b3747420fd7a9e5b1b9f56a256ca899ea3b78428 --- /dev/null +++ b/example_conflict-files-obsidian-git.md @@ -0,0 +1,17 @@ +# Conflicts +Please resolve them and commit them using the commands `Obsidian Git: Commit all changes` followed by `Obsidian Git: Push` +(This file will automatically be deleted before commit) +[[#Additional Instructions]] available below file list + +- [[README]] + +# Additional Instructions +I strongly recommend to use "Source mode" for viewing the conflicted files. For simple conflicts, in each file listed above replace every occurrence of the following text blocks with the desired text. + +```diff +<<<<<<< HEAD + File changes in local repository +======= + File changes in remote repository +>>>>>>> origin/main +``` \ No newline at end of file