obsidian-plugin/friebetill_obsidian-file-diff
1
0
Fork 0
mirror of https://github.com/friebetill/obsidian-file-diff.git synced 2026-07-22 07:40:25 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Improve the README

Browse source
This commit is contained in:
friebetill 2023-02-02 11:50:11 +08:00
parent a3e2ef35cc
commit 1dcb0dbc38
1 changed files with 53 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

57
README.md
View file

@ -2,10 +2,59 @@
<!-- [![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) -->
![GitHub stars](https://img.shields.io/github/stars/friebetill/obsidian-file-diff?style=flat)
See the differences between two files with [Obsidian](https://obsidian.md/) and merge the files with a few clicks.
## ⚠️ This plugin is in development and not working at the moment. ⚠️
<img src="https://user-images.githubusercontent.com/10923085/216142663-703e489e-6f47-4193-8e69-20c7fdfd6f61.gif" height="400"/>
## Purpose
This plugin adds a file difference command to [Obsidian](https://obsidian.md/),
allowing users to compare and merge changes between different versions of a
file.
## Compatibility
Compatible with all platforms (Windows, Linux, macOS, Android and iOS). TODO:
Test on Android and iOS. Tested with Obsidian v0.15.0 or higher.
## Installation
At the moment, the plugin is not yet available as an official plugin. Therefore, it must be installed manually:
1. Download the repository as a zip file
2. Unzip the file
3. Install node modules with `yarn install`
4. Build the plugin with `yarn build`
5. Copy `main.js`, `styles.css` and `manifest.json` in your plugin folder `VaultFolder/.obsidian/plugins/obsidian-file-diff/`
When the plugin is officially release you can follow these steps to install the plugin:
1. Open Obsidian
2. Click on the "Settings" icon in the bottom left corner
3. Click on "Community plugins"
4. Click on "Browse"
5. Search for "File Diff"
6. Click on "Install"
7. Click on "Enable"
## Usage
To use the plugin, follow these steps:
1. Open a file in Obsidian
2. Open the command palette (Ctrl/Cmd + P)
3. Search for "File Diff"
4. Select the file you want to compare with the current file
## Demo
<img
src="https://user-images.githubusercontent.com/10923085/216142663-703e489e-6f47-4193-8e69-20c7fdfd6f61.gif"
alt="GIF of a demo show this plugin" height="400" />
## 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.
## Support
For support, please open an issue on the repository.