This plugin was created as I have to go through 40+ GO microservices for which code was not built, which was adding extra time to do the analysis and documentation part. This is created for easing the document creation process by removing the file creation and copy snippet part, which saves a lot of time for developers.
CodeMark helps you collect and store code snippets from any file in your workspace, along with their relative paths, descriptions, and explanations. It streamlines the process of documenting code, making it easy to generate markdown documentation with just a few clicks.
Features
Quickly save selected code snippets with descriptions and explanations
Highlights saved snippets in the editor
Save all collected snippets to a markdown file (auto-named or custom location)
Status bar indicator for snippet collection and clearing
CodeLens UI for snippet actions
Works with any language and file type
Installation
From VSIX File
Download the latest .vsix file from the Releases or build it yourself (see below).
In VS Code, open the Command Palette (Ctrl+Shift+P).
Type Extensions: Install from VSIX... and select the downloaded .vsix file.
Reload VS Code if prompted.
From Source
Clone this repository:
git clone https://github.com/chinmay-sawant/Dokumenter.git
cd Dokumenter
Install dependencies:
npm install
Compile the extension:
npm run compile
Press F5 in VS Code to launch a new Extension Development Host window for testing.
To package for installation:
npm install -g vsce
vsce package
Then follow the VSIX installation steps above.
Usage
Select any code in your editor.
Use the CodeLens actions above the selection:
⚡ Quick Add: Save with description
＋ Add with Details: Save with description and explanation
⚡ Quick Save All: Save all snippets to a markdown file
💾 Save All As...: Choose file name/location for saving
🗑️ Clear All: Remove all highlights and snippets
✕ Cancel: Hide CodeLens UI
View and manage your snippets from the status bar or context menu.
Saved markdown files are stored in the markdowns/ folder by default.
Commands
codeSnippetCollector.saveSnippet: Save selected code as a snippet
codeSnippetCollector.clearHighlights: Clear all highlights
codeSnippetCollector.quickAdd: Quick add snippet
codeSnippetCollector.addWithDetails: Add snippet with details
codeSnippetCollector.quickSaveToFile: Save all snippets to file
codeSnippetCollector.saveAllAs: Save all snippets as...
