https://github.com/elitewise/obsidian-snippets

https://github.com/elitewise/obsidian-snippets

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/elitewise/obsidian-snippets
• Owner: EliteWise
• Created: 2024-11-17T14:42:33.000Z (about 2 months ago)
• Default Branch: master
• Last Pushed: 2024-11-24T17:04:37.000Z (about 2 months ago)
• Last Synced: 2024-11-24T17:26:39.487Z (about 2 months ago)
• Language: TypeScript
• Size: 58.6 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        
# **Obsidian Snippets**

Transfer selected code snippets from Visual Studio Code to your Obsidian Vault. This extension create organized Markdown notes for your code blocks/snippets in one click.

---

## **Features**

- ⚙️ **Configurable Path**: Set your Obsidian Vault path in the extension settings for a seamless integration.

- 💾 **Save Code Snippets**: Select a block of code in VS Code, right click and save it directly to a new Markdown note in your Obsidian Vault.

- 📂 **Organized Folder**: All snippets are saved in a dedicated "Snippets" folder by default within your Vault, with the appropriate language specified.

---

## **Requirements**

- **Obsidian** installed on your machine. [Download here](https://obsidian.md/download)

- **VS Code** version 1.75.0 or higher.

---

## **How to Use**

1. **Set up your Vault Path**:

   - Execute the command **"Configure Obsidian Folder"** from the Command Palette.

2. **Save a Snippet**:

   - Select a block of code in any file in VS Code.

   - Right-click and choose **"Save Code Snippet to Obsidian"** from the context menu.

   - Your snippet will be saved in the "Snippets" folder of your Vault.

3. **View in Obsidian**:

   - Open Obsidian and navigate to the "Snippets" folder to view your saved snippets.

---

## **Release Notes**

### **1.0.0**

- Coming soon!

---

## **Feedback and Support**

Have suggestions or encountered a bug? Open an issue on [GitHub](https://github.com/EliteWise/obsidian-snippets).

---

## **For Developers**

Follow the [VS Code Extension Guidelines](https://code.visualstudio.com/api/references/extension-guidelines) for best practices when contributing or forking this extension.

---

## **Enjoy!** 🎯