https://github.com/hamzabenyazid/obsidian-live-variables

Define variables in your note's properties and reuse them throughout your content.
https://github.com/hamzabenyazid/obsidian-live-variables

obsidian-md obsidian-plugin

Last synced: about 2 months ago
JSON representation

Define variables in your note's properties and reuse them throughout your content.

• Host: GitHub
• URL: https://github.com/hamzabenyazid/obsidian-live-variables
• Owner: HamzaBenyazid
• License: mit
• Created: 2024-06-11T17:13:51.000Z (7 months ago)
• Default Branch: master
• Last Pushed: 2024-10-23T14:39:01.000Z (2 months ago)
• Last Synced: 2024-10-31T01:27:48.459Z (about 2 months ago)
• Topics: obsidian-md, obsidian-plugin
• Language: TypeScript
• Homepage:
• Size: 983 KB
• Stars: 18
• Watchers: 1
• Forks: 0
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# Obsidian Live Variables Plugin

The Live Variables Plugin for Obsidian allows you to manage and reuse data across your notes by defining variables in the note’s properties. When a variable is updated, all instances of that variable in your note are automatically synchronized, ensuring consistency and saving time when dealing with frequently changing information.

## Features

- **Dynamic Variable Management**: Easily define and update variables within your note’s properties. Any change to a variable will automatically reflect throughout the note.

- **Cross-Note Variable Reuse**: Access and reuse variables from other notes within your vault.

- **Seamless Integration**: Fully integrated into Obsidian, enhancing your workflow without disrupting your note-taking experience.

- **Efficiency Boost**: Reduce manual updates for repetitive information across notes.

- **User-Friendly Interface**: Intuitive setup and management of variables with minimal effort.

## Getting Started

1. **Install the Plugin**:

   - Install directly from the Obsidian plugin marketplace, or manually download the latest release, unzip it, and place the folder in your vault's plugin directory. Enable the plugin in Obsidian’s settings.

2. **Define Variables**:

   - Open the note where you want to use variables.

   - In the note’s frontmatter (the YAML block), define your variables. Example:

     ```yaml

     ---

     projectName: Obsidian Live Variables Plugin

     dueDate: 2024-12-31

     ---

     ```

3. **Insert Variables**:

   You can insert variables using the following options:

   - **Local Variables**: Insert a variable defined within the current note by using the command: `Live Variables: Insert local variable`.

   - **Vault-Wide Variables**: Insert a variable defined in any note within the vault by using the command: `Live Variables: Insert variable from another note`.

4. **Update Variables**:

   - Modify the value of a variable in the note’s properties, and all references to that variable across your vault will be updated instantly.

## Demo

Check out the plugin in action with this demo:

![Demo](demo/demo.gif)

## Contributing

We welcome contributions! If you have suggestions for improvements or new features, feel free to open an issue or submit a pull request.

## License

This project is licensed under the MIT License.