pace-gene/org-mode

★ 0Forks 0Tree-sitter QueryGitHub ↗Compare

README

Zed Org Mode

An Org Mode extension for Zed, bringing Emacs-style structured plain text editing, task management, and document authoring to Zed.

Features

  • Syntax highlighting for Org Mode files (.org)
  • Structured editing with proper indentation and folding
  • TODO keywords recognition and highlighting
  • Timestamps and scheduling support
  • Links and markup syntax support
  • Code blocks with language-specific highlighting
  • Tables support
  • Tags and properties recognition

Supported Org Mode Elements

  • Headings with different levels (*, **, ***, etc.)
  • TODO/DONE keywords and custom workflow states
  • Emphasis markup (bold, italic, underline, verbatim, code, strikethrough)
  • Lists (ordered and unordered)
  • Links (internal and external)
  • Timestamps and date/time expressions
  • Properties and drawers
  • Source code blocks with language specification
  • Tables with proper alignment
  • Tags and priorities
  • Comments and special keywords

Installation

  1. Open Zed
  2. Open the Extensions view (cmd+shift+x / ctrl+shift+x)
  3. Search for "Org Mode"
  4. Click Install

Alternatively, you can install it from the command line:

zed --install-extension org-mode

Usage

Simply open any .org file in Zed, and the extension will automatically provide syntax highlighting and language support.

Example Org Mode Content

#+TITLE: My Org Document
#+AUTHOR: Your Name
#+DATE: <2024-01-01>

* TODO Project Planning [1/3]
  SCHEDULED: <2024-01-15 Mon>
  
  Some project description with *bold* and /italic/ text.
  
** DONE Research phase
   CLOSED: [2024-01-10 Wed 14:30]
   
** TODO Implementation
   :PROPERTIES:
   :Effort: 8h
   :END:
   
** TODO Testing
   
* Notes
  
  Here's a [[https://orgmode.org][link to Org Mode]] documentation.
  
  #+BEGIN_SRC python
  def hello_world():
      print("Hello from Org Mode!")
  #+END_SRC
  
  | Name    | Age | City     |
  |---------+-----+----------|
  | Alice   |  30 | New York |
  | Bob     |  25 | London   |

Development

To develop this extension, see the Developing Extensions section of the Zed docs.

Building from Source

  1. Clone this repository
  2. Open the project in Zed
  3. The extension will be automatically loaded for development

Contributing

Contributions are welcome! Please feel free to submit issues, feature requests, or pull requests.

License

This project is licensed under the Apache License 2.0 - see the LICENSE file for details.

Acknowledgments

Contributors

pace-gene

Issues