A VS Code extension that provides live preview of GSN (Goal Structuring Notation) YAML files using the gsn2x tool. This extension allows you to visualize and navigate GSN diagrams directly within VS Code.
Features
Core Functionality
Live Preview: Automatically generates and displays SVG diagrams from GSN YAML files using gsn2x
Interactive Navigation: Click on links in diagrams to navigate between related GSN elements
Navigation History: Use back/forward buttons to navigate through diagram history
Zoom Controls: Zoom in/out and reset zoom with mouse wheel or keyboard shortcuts (Ctrl+Scroll, Ctrl+/-, Ctrl+0)
Additional Views
Statistics: View generated statistics about the GSN model
Evidence: Display evidence files associated with the GSN model
Complete View: Access the complete diagram view (if generated)
Architecture View: View the architecture diagram (if generated)
Requirements
VS Code: Version 1.87.0 or higher
Installing gsn2x
If you don't have gsn2x installed, this extension will get you the latest version.
Download the appropriate version for your platform from the gsn2x releases.
Extension Settings
This extension contributes the following settings:
gsn2xPreview.gsn2xPath: Path to the gsn2x executable (default: "gsn2x")
gsn2xPreview.wordWrap: Word wrap width for diagram text (default: 15)
Usage
Open a GSN YAML file in VS Code
Use Command Palette (Ctrl+Shift+P) and select "Preview file using gsn2x"
The diagram will be generated and displayed in a side panel
Click on elements to navigate to linked diagrams
Use the buttons at the bottom to view statistics, evidence, or additional diagram views
Keyboard Shortcuts
Ctrl+Scroll: Zoom in/out
Ctrl++: Zoom in
Ctrl+-: Zoom out
Ctrl+0: Reset zoom
Release Notes
0.2.1
Fix of README.md
0.2.0
Auto-installing of gsn2x
Better visualization and rendering
0.1.0
Initial release with core GSN preview functionality:
Basic SVG diagram rendering
Link navigation
Zoom controls
Statistics and evidence viewing
Complete and architecture view support
Custom markdown renderer with nested list support
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.
