friebetill_obsidian-file-diff/README.md

45 lines
1.7 KiB
Markdown
Raw Permalink Normal View History

2023-01-26 05:50:48 +00:00
# Obsidian File Diff
2023-01-26 05:13:41 +00:00
[![Obsidian Downloads](https://img.shields.io/badge/dynamic/json?color=7e6ad6&labelColor=34208c&label=Obsidian%20Downloads&query=$['file-diff'].downloads&url=https://raw.githubusercontent.com/obsidianmd/obsidian-releases/master/community-plugin-stats.json&)](obsidian://show-plugin?id=file-diff)
2023-01-26 05:50:48 +00:00
![GitHub stars](https://img.shields.io/github/stars/friebetill/obsidian-file-diff?style=flat)
2023-01-26 05:13:41 +00:00
2023-02-04 05:30:30 +00:00
## Commands
2023-02-04 05:30:30 +00:00
`Compare`: Compare your active file with another file and look at the differences.
2023-02-04 06:34:09 +00:00
`Compare and merge`: Same as `Compare`, but you have the option to merge changes.
2023-02-02 03:50:11 +00:00
`Find sync conflicts and merge`: Finds all Syncthing conflicts and shows the merge option for each conflict sequentially.
<img
src="https://user-images.githubusercontent.com/10923085/216749496-27f0b241-c05b-4aec-ba88-a7c8c91938a6.gif"
alt="GIF of a demo show this plugin" width="900" />
2023-02-15 13:20:36 +00:00
## Motivation
2023-11-08 11:52:26 +00:00
I created this plugin because I use [SyncThing](https://syncthing.net/) and it bothered me to clean up merge conflicts by hand.
2023-02-02 03:50:11 +00:00
## Installation
1. Search for "File Diff" in the community plugins of Obsidian
2. Install the plugin
3. Enable the plugin
2023-02-02 03:50:11 +00:00
2023-02-10 04:33:11 +00:00
## FAQ
1. How do I adjust the colors?
Adjust the colors by following [these instructions](https://github.com/friebetill/obsidian-file-diff/issues/1#issuecomment-1425157959).
2023-02-02 03:50:11 +00:00
## Contributing
If you have any issues or suggestions, please open an issue on the repository.
If you would like to contribute code, please fork the repository and submit a
pull request.
2023-02-02 03:50:11 +00:00
## Support
2023-02-04 07:01:08 +00:00
For support, please open an issue on the repository, with a reproducible example if possible.
2023-02-04 05:09:39 +00:00
If you're interested in supporting me, it would mean a lot if you could buy me a coffee through GitHub Sponsors, located on the right side.