A lightweight desktop application that creates symlinks in your Obsidian vault to external markdown files on your computer.

• Select your Obsidian vault folder
• Choose markdown files to symlink into your vault
• Create symlinks with a single click
• View recent symlinks
• Native look and feel with dark mode support

• Node.js (v14 or higher)
• npm (comes with Node.js)

1. Clone this repository
2. Install dependencies:

   npm install

To run the application in development mode:

npm start

To build the application for your current platform:

npm run build

Platform-specific builds:

• macOS: npm run package-mac
• Windows: npm run package-win
• Linux: npm run package-linux

1. Launch the application
2. Select your Obsidian vault folder
3. Choose the markdown files you want to symlink into your vault
4. Click "Create Symlinks"
5. The selected files will be symlinked into your Obsidian vault

• On Windows, the app creates junction points instead of symbolic links to avoid requiring administrator privileges
• The app remembers your previously selected Obsidian vault
• Recent symlinks are saved for quick reference

MIT

This project uses Biome for linting and formatting. Biome is a fast formatter and linter that helps maintain consistent code style across the project.

• npm run lint - Run Biome linting to check for code style issues
• npm run format - Format code with Biome
• npm run check - Run all Biome checks and fix automatically when possible

We use Husky and lint-staged to ensure code quality checks run before each commit. This helps maintain consistent code quality and prevents committing code with linting errors.

Biome configuration is located in the biome.json file at the project root. The configuration follows Biome's recommended defaults with minimal customizations