README file from
Github🐞 Create issues, feature requests, share your ideas
Purpose
This plugin lets you render Git diff output in your notes that looks like this:
I personally use it in a combo with obsidian-git to revise what I've been working on a given day, like an automatic changelog, but you can point it to any repo in your file system.
Usage
For the plugin to work on your vault, it should be a git repository. You can add automatic git backups to your vault with obsidian-git.
The plugin renders Markdown code blocks with the show-diff language tag. An empty code block will show a diff between today and yesterday:
dates
With dates you can specify a date range to show changes for:
commits
With commits you can specify a commit range to show changes for:
path
This defaults to the vault you're in, but you can point the plugin to any repository in your file system:
exclude
.obsidian (Obsidian's settings & cache) is excluded by default. You can override this with a single path:
or with a list of paths:
Command: Generate diff code block for today
The plugin provides a command to quickly insert in a note a code block like this:
Contributing
If you noticed a bug or thought of some way to improve the plugin, feel free to create an issue: https://github.com/ivan-lednev/obsidian-automatic-changelog/issues.
Pull-requests are also welcome! If you want to contribute but don't know where to start, you can create an issue or write me an email: [email protected].
You can also support me by buying me a coffee:
Acknowledgements
I've used the following plugins as a reference: