Skip to content

Syr0/R.E.L.A.X.

Repository files navigation

R.E.L.A.X Logo

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

Community & Support:

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? so I can relax even more!