Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/arshad115/obsidian-linker

Obsidian Linker is a tool designed to automatically link your notes in Obsidian.
https://github.com/arshad115/obsidian-linker

notes obsidian obsidian-md python

Last synced: 17 days ago
JSON representation

Obsidian Linker is a tool designed to automatically link your notes in Obsidian.

Host: GitHub
URL: https://github.com/arshad115/obsidian-linker
Owner: arshad115
Created: 2025-01-03T13:08:24.000Z (19 days ago)
Default Branch: main
Last Pushed: 2025-01-04T18:45:54.000Z (18 days ago)
Last Synced: 2025-01-04T19:20:27.119Z (18 days ago)
Topics: notes, obsidian, obsidian-md, python
Language: Python
Homepage:
Size: 23.4 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# Obsidian Linker

[![Run Tests](https://github.com/arshad115/obsidian-linker/actions/workflows/run-tests.yml/badge.svg)](https://github.com/arshad115/obsidian-linker/actions/workflows/run-tests.yml)

## Overview

Obsidian Linker is a tool designed to help you manage and link your notes in Obsidian. It provides various features to enhance your note-taking experience.

## Features

- Automatic linking of notes
- Uses Wikilink format
- Skip links in metadata
- Skip links in codeblocks, inline code

## Installation

To install Obsidian Linker, follow these steps:

1. Clone the repository:
```sh
git clone https://github.com/your-username/obsidian-linker.git
```
2. Navigate to the project directory:
```sh
cd obsidian-linker
```
3. Install the required dependencies:
```sh
pip install -r requirements.txt
```

## Usage

To use Obsidian Linker, run the following command:
```sh
python obsidianlinker.py /path/to/vault/
````

Make sure to back up your vault before using this tool, as it can make irreversible edits.
## Running Tests

To run tests for Obsidian Linker, use the following command:
```sh
pytest
```

This will execute all the tests and provide you with a summary of the results. Make sure you have all the necessary dependencies installed before running the tests.

## TODO

- [ ] Add support for alias links
- [ ] Multithreading
- [ ] Write additional tests for edge cases
- [ ] Make it into a plugin for Obsidian

## Contributors

- [Arshad Mehmood](https://github.com/arshad115)

## Contributing

We welcome contributions to Obsidian Linker! If you have an idea for a new feature or have found a bug, please open an issue or submit a pull request.

### Steps to Contribute

1. Fork the repository.
2. Create a new branch for your feature or bugfix:
```sh
git checkout -b feature-name
```
3. Make your changes and commit them:
```sh
git commit -m "Description of your changes"
```
4. Push your changes to your fork:
```sh
git push origin feature-name
```
5. Open a pull request on the main repository.

## License