https://github.com/Syr0/R.E.L.A.X.

Regex Obsidian Plugin
https://github.com/Syr0/R.E.L.A.X.

Last synced: 2 months ago
JSON representation

Regex Obsidian Plugin

• Host: GitHub
• URL: https://github.com/Syr0/R.E.L.A.X.
• Owner: Syr0
• License: mit
• Created: 2023-11-24T21:06:09.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-05-22T17:18:28.000Z (8 months ago)
• Last Synced: 2024-08-08T00:44:35.269Z (6 months ago)
• Language: TypeScript
• Size: 1.25 MB
• Stars: 19
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• project-awesome - Syr0/R.E.L.A.X. - Regex Obsidian Plugin (TypeScript)

README

        


  

  
R.E.L.A.X. (Regular Expression Link Analysis Xpert)

  


  

  

  

  

  

  

  



	


Enhance your Obsidian experience with R.E.L.A.X., a powerful regex plugin that leverages regular expressions for dynamic and intelligent note linking.

### USAGE:

- **Rightclick, click "R.E.L.A.X.". This will put all the Information found via predefined regex into brackets, linking your files.

- **Open Settings and set up your own custom Regular Expression. Note: Each RegEx should have exactly one catching group.

## Example: ##

**Regular Expression for Digits:**

- 12345

- 23456

- 54468

**Your Regex would be like this:**

- (\d{5)

- ([1-9]{5})

- ([1-9][1-9][1-9][1-9][1-9])

**Not allowed would be this:**

- (([1-9])([1-9])([1-9])([1-9])([1-9]))

Because it is unclear which group to link. To cause a group not to capture, write ?: at the beginning.

- **This would be the same (crap), but it would work:

- **((?:[1-9])(?:[1-9])(?:[1-9])(?:[1-9])(?:[1-9]))

1. **Access Obsidian Settings:** Open your Obsidian application and click on the 'Settings' icon.

2. **Enable Community Plugins:** In the Settings, navigate to 'Community Plugins' and turn off 'Restricted Mode'.

3. **Browse and Install Plugins:** Click on 'Browse' and find the R.E.L.A.X. plugin.

4. **Install the Plugin:** Click 'Install' on the plugin’s page.

5. **Enable the Plugin:** Toggle it on in the 'Installed plugins' section.

6. **Configure the Plugin (Optional):** Set up the plugin in its settings panel.

7. **Start Using the Plugin:** Righclick>R.E.L.A.X. or use the command panel. All your Regex-findings will be turnted into links!

## Demo Video

[![Youtube R.E.L.A.X. Demonstration](https://upload.wikimedia.org/wikipedia/commons/3/3f/YOUTUBE--SOCIAL-PLAY.png)](http://www.youtube.com/watch?v=SoRKFwc-UJw)

### Community & Support:

- **Forums & Discord:** Chill with fellow users on [Obsidian Forums](#) and [Discord](#).

- **Need Help?:** Holler on our [GitHub](#).

### License:

R.E.L.A.X. comes with an MIT License - free to use but at your own risk. Check [LICENSE](#) for more details.

### Contributions:

Got ideas? Sprinkle your magic in [CONTRIBUTING.md](#).

### Shoutouts:

Big thanks to the Obsidian crew and all the brilliant minds behind this project.

#### Support R.E.L.A.X.:

Enjoying R.E.L.A.X.? [Why not buy me a coffee then?](https://buymeacoffee.com/Syr1) so I can relax even more!