SnippetNote
SnippetNote is a VS Code extension designed to help you take notes and export them while learning project code.
Features
- Select code snippets and generate explanations using GitHub Copilot.
- Export code snippets and explanations to Markdown file.
- Add and remove notes in an existing Markdown file with automatic numbering.
Installation
- Download and install Visual Studio Code.
- Open the command palette (press
Ctrl+Shift+P).
- Type and select
Extensions: Install from VSIX....
- Choose the generated
.vsix file to install.
Usage
- Open a project in Visual Studio Code
- Select a piece of code.
- Right-click the selected code snippet and choose
SnippetNote: Insert a new code snippet.
- Enter a title for the code snippet in the input box.
- Check the
SnippetNotes.md file in the project root directory to ensure the code snippet and explanation are added in the expected format.
Following Extension Guidelines
Ensure that you've read through the extension guidelines and follow the best practices for creating your extension.
Working with Markdown
You can author your README using Visual Studio Code. Here are some useful editor keyboard shortcuts:
- Split the editor (
Cmd+\ on macOS or Ctrl+\ on Windows and Linux).
- Toggle preview (
Shift+Cmd+V on macOS or Shift+Ctrl+V on Windows and Linux).
- Press
Ctrl+Space (Windows, Linux, macOS) to see a list of Markdown snippets.
Contributing
Contributions are welcome! Please visit the GitHub repository for more information.
License
This project is licensed under the MIT License. See the LICENSE file for details.
Enjoy!
| |
