Convert ORG to JSON

Why Convert ORG to JSON?

Converting Org-mode documents to JSON makes your structured data accessible to any programming language or application. JSON is the universal data interchange format for web APIs, databases, and applications. This conversion bridges the gap between Org-mode productivity and modern software development.

JSON preserves the hierarchical structure of your Org documents. Headings become nested objects, lists become arrays, and properties become key-value pairs. This makes your Org data programmatically accessible for automation, analysis, or integration with other tools.

For developers using Org-mode for project management, converting to JSON enables integration with web dashboards, mobile apps, or data visualization tools. Your tasks, deadlines, and properties become API-ready data that can power custom applications.

Data scientists can use JSON output for analysis. Convert your research notes, structured data, or experimental logs to JSON and process them with Python, R, or JavaScript. The structured format makes it easy to extract, filter, and analyze your Org content.

Key Benefits of Converting ORG to JSON:

• Universal Compatibility: Works with every programming language
• API Ready: Perfect for web services and integrations
• Structured Data: Preserves hierarchy and properties
• Database Storage: Import directly into MongoDB, PostgreSQL
• Automation: Process Org data with scripts and tools
• Type Safety: Numbers, booleans, and strings are typed
• Data Analysis: Easy to process with data science tools

Practical Examples

Example 1: Task List to API Data

Input ORG file (tasks.org):

#+TITLE: Sprint Tasks

* TODO Implement user authentication
DEADLINE: <2024-01-15>
:PROPERTIES:
:story_points: 5
:assignee: alice
:sprint: 12
:END:

* DONE Design database schema
CLOSED: [2024-01-10]
:PROPERTIES:
:story_points: 3
:assignee: bob
:sprint: 12
:END:

* IN-PROGRESS Build REST API
:PROPERTIES:
:story_points: 8
:assignee: carol
:sprint: 12
:END:

Output JSON:

{
  "title": "Sprint Tasks",
  "tasks": [
    {
      "title": "Implement user authentication",
      "status": "TODO",
      "deadline": "2024-01-15",
      "story_points": 5,
      "assignee": "alice",
      "sprint": 12
    },
    {
      "title": "Design database schema",
      "status": "DONE",
      "closed": "2024-01-10",
      "story_points": 3,
      "assignee": "bob",
      "sprint": 12
    },
    {
      "title": "Build REST API",
      "status": "IN-PROGRESS",
      "story_points": 8,
      "assignee": "carol",
      "sprint": 12
    }
  ]
}

Example 2: Knowledge Base to Searchable Data

Input ORG file (notes.org):

#+TITLE: Programming Notes

* Python
:PROPERTIES:
:category: languages
:END:

** List Comprehensions

Concise way to create lists:

#+BEGIN_SRC python
squares = [x**2 for x in range(10)]
#+END_SRC

** Decorators

Functions that modify other functions.

* JavaScript
:PROPERTIES:
:category: languages
:END:

** Promises

Handle asynchronous operations.

Output JSON:

{
  "title": "Programming Notes",
  "sections": [
    {
      "name": "Python",
      "category": "languages",
      "topics": [
        {
          "name": "List Comprehensions",
          "content": "Concise way to create lists:",
          "code": "squares = [x**2 for x in range(10)]",
          "language": "python"
        },
        {
          "name": "Decorators",
          "content": "Functions that modify other functions."
        }
      ]
    },
    {
      "name": "JavaScript",
      "category": "languages",
      "topics": [
        {
          "name": "Promises",
          "content": "Handle asynchronous operations."
        }
      ]
    }
  ]
}

Example 3: Meeting Notes to Database

Input ORG file (meetings.org):

#+TITLE: Team Meetings

* Weekly Standup - 2024-01-15
:PROPERTIES:
:attendees: alice, bob, carol
:duration: 30
:END:

** Action Items
- [ ] Alice: Review PR #123
- [X] Bob: Deploy to staging
- [ ] Carol: Update documentation

* Sprint Planning - 2024-01-12
:PROPERTIES:
:attendees: alice, bob, carol, dave
:duration: 60
:END:

Output JSON:

{
  "title": "Team Meetings",
  "meetings": [
    {
      "name": "Weekly Standup",
      "date": "2024-01-15",
      "attendees": ["alice", "bob", "carol"],
      "duration": 30,
      "action_items": [
        {"assignee": "Alice", "task": "Review PR #123", "done": false},
        {"assignee": "Bob", "task": "Deploy to staging", "done": true},
        {"assignee": "Carol", "task": "Update documentation", "done": false}
      ]
    },
    {
      "name": "Sprint Planning",
      "date": "2024-01-12",
      "attendees": ["alice", "bob", "carol", "dave"],
      "duration": 60
    }
  ]
}

Frequently Asked Questions (FAQ)

Q: How is the Org hierarchy represented in JSON?

A: Org headings become nested objects in JSON. Top-level headings become array elements, subheadings become nested "children" arrays. Properties become object keys, and the heading text becomes a "title" or "heading" field.

Q: Are TODO states and timestamps preserved?

A: Yes! TODO keywords become a "status" field, DEADLINE becomes a "deadline" field with ISO date format, SCHEDULED becomes "scheduled", and CLOSED timestamps are preserved. All Org-mode scheduling data is captured in the JSON.

Q: How are Org tables converted?

A: Tables are converted to arrays of objects, with the header row providing field names. Each table row becomes an object with keys from the header. This structure is ideal for database import or data processing.

Q: What about code blocks?

A: Code blocks are included as objects with "code" (the content) and "language" (from the #+BEGIN_SRC language specification) fields. This preserves the code for syntax highlighting or execution in other systems.

Q: Is the JSON output valid and parseable?

A: Yes, the output is valid JSON per RFC 8259. It can be parsed by JSON.parse() in JavaScript, json.loads() in Python, or any standard JSON parser. Special characters are properly escaped.

Q: Can I use this with databases?

A: Absolutely. The JSON can be imported directly into document databases like MongoDB, stored in PostgreSQL's JSONB columns, or processed into relational tables. The hierarchical structure maps well to NoSQL databases.

Q: How are Org links converted?

A: Links are converted to objects with "url" and "description" fields, or just the URL string if there's no description. Internal links (to headings) reference the heading's ID or title.

Q: Can I convert JSON back to ORG?

A: If the JSON follows the expected structure, yes. Custom scripts can convert JSON back to Org format. However, some formatting details (like exact whitespace) may differ from the original. The semantic content is preserved.