VOrg - Org-mode Preview for VS Code

Language: 中文 | English

VOrg is a simple VS Code extension developed to provide basic Org-mode functionality in VS Code. It doesn't aim to completely replicate the Emacs Org-mode experience, so many features are not implemented in this component. The main advantage over Emacs Org-mode is the preview experience.

✨ Core Features

🔄 Real-time Preview

• Real-time Preview: View rendered effects while editing
• Scroll Synchronization: Automatic scroll synchronization between editor and preview window

🎨 Syntax Highlighting

VOrg provides complete Org-mode syntax highlighting support, including headings, TODO states, text formatting, lists, code blocks, tables, links, math formulas, timestamps, and more. For detailed information, please refer to Syntax Highlighting Documentation.

📋 Smart Navigation

• Document Outline: Automatically parses document structure and provides complete Outline navigation
• Quick Jump: Use Ctrl+Shift+O (Windows/Linux) or Cmd+Shift+O (Mac) to quickly jump to headings

🔗 Link Navigation

Supports intelligent navigation for multiple link types:

• [[link][description]] - Links with descriptions
• [[link]] - Simple links
• file:path/to/file - File links
• http://example.com - Web links
• [[*heading]] - Internal links to headings in the same file
• [[id:XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX][description]] - Global ID navigation (supports cross-file)

⚡ Org-like Editing Features

Context-aware editing similar to Emacs org-meta-return:

• Automatically recognizes current context (headings, lists, tables, Property drawers, etc.)
• Intelligently inserts new elements (headings, list items, table rows, Property items, etc.)
• Maintains correct hierarchy and formatting

TAB Smart Folding (similar to Emacs org-mode TAB behavior):

• On headings: Toggle fold/expand state
• On list items: Toggle fold state or increase indentation
• On code block headings: Toggle code block fold/expand state
• On Property drawers: Toggle Property drawer fold/expand state
• In tables: Move to next cell
• In code blocks: Normal code indentation

Property Management:

• Intelligently set/update heading properties
• Automatically create Property drawers (with unique ID)
• Property drawer folding support

🚀 Quick Start

Basic Usage

🛠️ Configuration Options

TODO Keywords Customization

You can customize TODO keywords in VS Code settings:

{
  "vorg.todoKeywords": "TODO(t) NEXT(n) WAITING(w) | DONE(d) CANCELLED(c)",
  "vorg.defaultTodoKeyword": "TODO"
}

• Before | are incomplete states, after | are completed states
• Example: "PreSale InDelivery HANGUP(@/!) End(@/!) | Terminated(@/!) DONE(@/!)"

CodeLens Action Buttons

Control whether to show action buttons (like Promote, Demote on heading lines) in the editor:

{
  "vorg.showCodeLens": true
}

• true (default): Show action buttons
• false: Hide action buttons

When enabled, action buttons will appear above each heading line for quick access to operations.

📁 Supported File Types

• .org - Org-mode document files

🆚 Comparison with Other Org Extensions

🐛 Issue Reporting

If you encounter problems or have improvement suggestions:

• 🐛 Issue Reporting: Create GitHub Issue
• 💡 Feature Suggestions: Join GitHub Discussions

📝 Changelog

v0.0.3 (Latest)

• ✨ Added Property Management: Complete org-set-property functionality implementation

v0.0.2

• ✨ Basic Org-mode functionality implementation
• 🔄 Real-time preview and scroll synchronization
• 📋 Document outline and smart navigation
• ⚡ Smart editing and folding features

🔮 Roadmap

• [ ] Add headline navigation functionality
• [ ] Add chart support (Mermaid)
• [ ] Support refile functionality
• [ ] Support headline tree operations
  • [ ] org-pro/demote-subtree
  • [ ] cut-subtree
  • [ ] org-metadown/up
• [ ] TODO-related display
• [ ] Support plugins or custom code
• [ ] Hints: e.g., on headlines, show hints for promote or demote
• [ ] Implement Ctrl-c Ctrl-c functionality
• [ ] Add unit tests
• [ ] Support SQL queries
• [ ] Current bug: When cutting a list and pasting it, it adds an extra indentation
• [ ] Bug: In tables, using meta-return and ctrl-return currently doesn't behave correctly
• [X] Bug: In vorg preview, checkbox lists don't have a dot in front, causing style mismatch
• [ ] Structure split: vorg-core responsible for org format parsing, vorg-publish

VOrg - Making Org-mode editing more modern and efficient! 🚀

If this extension helps you, please give us a ⭐️ rating!