SnippetorA lightweight VS Code extension to save and share your knowledge about source code. 🚀 What is Snippetor?Snippetor is a powerful and privacy-first VS Code extension that allows you to capture and share Software Architecture Snippets. Think of it as a way to leave breadcrumbs of your knowledge and design decisions directly within your codebase. Instead of writing long, disconnected documents, a snippet is a sequence of notes tied to specific files and line numbers. This makes it easy to:
📋 What is a Snippet?A snippet is a collection of one or more items, each consisting of:
Together, these items describe the flow, design decisions, or internal logic of a piece of code. This structured format helps document key insights in a clear and contextual way. 📁 Where is Your Data Stored?Your data is always yours. Snippetor is designed with a privacy-first philosophy, which means no data is ever sent to a remote server. By default, the extension creates your snippet data in a local folder:
You have full control over your storage location and can use shared folders for collaboration, such as:
This flexibility allows you to choose your own backend and storage method, making collaboration seamless and secure without relying on any external service. 🛠 Features
💻 How to Build from SourceWant to build Snippetor yourself? It's simple!
Once compiled, you can run and debug the extension in VS Code. 🗺️ Future PlansWe have exciting plans for Snippetor to make it even more powerful. Stay tuned for:
🤝 ContributingWe welcome your feedback and contributions! Whether you want to fix a bug, add a new feature, or improve the documentation, your help is appreciated. Feel free to:
📃 LicenseThis project is licensed under the MIT License. You are free to use, modify, and distribute this software for both personal and commercial projects. |