obsidian-plugin/shumadrid_obsidian-git-changelog
1
0
Fork 0
mirror of https://github.com/shumadrid/obsidian-git-changelog.git synced 2026-07-22 05:42:16 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: update README

Browse source
This commit is contained in:
shumadrid 2025-03-23 16:47:48 +01:00
parent 1b2ff8f794
commit c872ed88c8
2 changed files with 11 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

BIN
.github/showcase.gif vendored Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 2.9 MiB

11
README.md
View file

@ -2,6 +2,8 @@
A new [Obsidian](https://obsidian.md) plugin that utilizes Git commit history to display dynamic changelogs in your sidebar. Also usable as a practical data loss monitoring tool.
![Showcase](.github/showcase.gif)
## Installation
To install the plugin, follow these steps:
@ -37,6 +39,13 @@ The plugin is NOT yet available in [the official Community Plugins repository](h
Common examples for this: `.trash` and `.obsidian` folders, `.canvas` files, or syncing service conflict files that can clutter the changelog stats.
Also use this setting to filter files and folders that already exist in previous commits, since specifying files in .gitignore doesn't remove them from previous commits.
**Context menu integration:** To exclude a file or folder, just right-click on it inside the File explorer and select "Git changelog: Exclude" from the context menu, no need to manually define paths.
> [!NOTE]
> For advanced users: If you configured your Git repository to be below the vault root directory, the paths should be relative to the Git repo, not the vault.
![Vault Changelog View](.github/vault-changelog-view.webp)
### File Changelog View
@ -92,6 +101,8 @@ This is because this plugin only compares neighboring versions (intervals) direc
Consequently, if you add text that gets lost within the same interval, you can detect this data loss **not** by seeing a high 'lines deleted' count, but by noticing a lack of expected additions.
A "Copy commit hash" context menu option is provided so that you can further investigate the commit tied to some suspicious version.
If some lost data was never committed, it won't be recoverable by Git. So it's recommended to configure a frequent (< 5 minutes) auto-commit interval (no need to manually stage and commit files).
But if some version of a file wasn't committed, you can still rely on the [File Recovery](https://help.obsidian.md/plugins/file-recovery) plugin, or the [Version history](https://help.obsidian.md/Obsidian+Sync/Version+history) feature to recover it.