Skip to content

genropy/vscode-gtext

Repository files navigation

gtext Preview for VSCode

Live preview extension for gtext documents.

Features

  • Live Preview: Open preview in VSCode with auto-refresh
  • Side-by-Side: View source and preview side-by-side
  • Auto-Refresh: Preview updates automatically when you save the file
  • Error Display: Shows errors directly in the preview

Requirements

  • gtext with serve support installed:
    pip install 'gtext[serve]'

Usage

Open Preview

  1. Open a .gtext file in VSCode
  2. Click the preview icon in the editor title bar
  3. Or use Command Palette: gtext: Open Preview

Commands

  • gtext: Open Preview - Open preview in current column
  • gtext: Open Preview to the Side - Open preview side-by-side
  • gtext: Stop Preview Server - Stop the preview server

Configuration

  • gtext.preview.port - Port for preview server (default: 8080)
  • gtext.preview.autoRefresh - Auto-refresh on file changes (default: true)

How it Works

The extension:

  1. Detects .gtext files
  2. Launches gtext serve in the background
  3. Shows the preview in a VSCode webview
  4. The preview auto-refreshes via gtext serve's polling mechanism

Development

# Install dependencies
npm install

# Compile
npm run compile

# Watch mode
npm run watch

# Run extension
# Press F5 in VSCode to open Extension Development Host

License

MIT License - see LICENSE for details.

Links

About

VSCode extension for gtext - syntax highlighting, snippets, and rendering

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors