Metadata-Version: 2.4
Name: tree-sitter-org
Version: 0.23.8
Summary: Tree-sitter grammar for Org Mode syntax
License-Expression: MIT
Project-URL: Homepage, https://github.com/idorobots/tree-sitter-org
Keywords: incremental,parsing,tree-sitter,org
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Compilers
Classifier: Topic :: Text Processing :: Linguistic
Classifier: Typing :: Typed
Requires-Python: >=3.10
Description-Content-Type: text/plain
License-File: LICENSE
Provides-Extra: core
Requires-Dist: tree-sitter~=0.24; extra == "core"
Dynamic: license-file

#+TITLE: Tree-Sitter Org-Mode parser

* Overview
This project implements a Tree-Sitter-based parser for Emacs Org-Mode files.

The long-term goal is high fidelity and eventually 100% feature coverage, while
keeping robust error recovery and useful parse trees for downstream processing.

* Supported features
Parsing [[examples/showcase.org][this file]] results in [[examples/showcase.tree-sitter][the following parse tree]].
See the other [[file:examples/][example files]] to get a better idea what this parser can parse.

* Gotchas
- Table.el tables parse as verbatim blocks of text. Their contents are inaccessible.
- Malformed objects are usually treated as plaintext or recovered with generic
  parse-error nodes.

* Explicitly Not Supported
- Inline tasks are not represented as a dedicated node type,
  they are treated as regular headings.
- Sexp timestamps (like =<%%(...)>=) are not parsed as regular timestamp nodes,
  they are plain text instead.
- LaTeX fragments & environments are not parsed as structured Org objects,
  they are plain text instead.

* Roadmap
See [[file:ROADMAP.org][ROADMAP.org]] for planned work and milestone history.
