org-json

Don't use this package, its been replaced with ox-json.

This package is for encoding all or part of an Org mode file's Abstract Syntax Tree (AST) into JSON format so that it can be read by other tools.

Usage

The primary interactive entry point is org-json-export-buffer, which prompts for a file name and exports the entire buffer's AST. The equivalent API function is org-json-encode-buffer, which returns a string. Additionally, you can use org-json-encode-node to encode an AST node (org element or object) from the data structure returned by one of the org-element functions (org-element-parse-buffer, org-element-at-point, etc.).

Output

The output looks like:

{
  "$$data_type": "org-node",
  "type": "headline",
  "properties": { ... },
  "keywords": { ... },
  "contents": [ ... ]
}

"type" is the node type returned by org-element-type and "properties" are property names and values obtained from org-element-property (see documentation for the Org element API for a complete list of all node types and properties). Leading colons in the property keys are omitted. "contents" is the encoded return value of org-element-contents, the items of which are either more org nodes or strings. Any elements of type "keyword" are omitted from the contents list and instead included as key-value pairs in the "keywords" property, which is not included otherwise.

Nested data objects

The "$$data-type" property is added to differentiate encoded org nodes and other data types from generic sets of key/value pairs that occur in alists or plists (the latter of which has "$$data-type": "mapping").

Additional data types are:

{
  "$$data-type": "error",
  "message": "Describes an error in automatically encoding this data structure."
}

JSON schemas

Check out the json-schemas subdirectory for JSON schema definitions of the output (work in progress).

"Falsy" values

The resulting JSON should include the correct choice of empty object ("{}"), empty list ("[]"), null, or false for the given context, even though these are all given a value of nil in elisp (don`t get me started).

Agenda export

Agenda export is a work in progress. Use org-json-encode-agenda-buffer to encode all items in an active agenda buffer. Use the macro org-json-with-agenda-buffer to run an agenda command in a temporary buffer, like so:

(org-json-with-agenda-buffer "t"
  (setq my-json-string (org-json-encode-agenda-buffer))

There is no interactive command yet.

Customization

You can customize which properties of different element types are included in the output and how they are processed by customizing the org-json-node-property-types-plist and org-json-property-formatters-plist (see the built-in documentation).

Related tools

The pyorg Python package can be used to read the exported JSON and convert it to other formats for export or display.

jlumpe/org-json