README.md — sigil-org

1# sigil-org

A [Sigil](https://codeberg.org/sigil/sigil) library for parsing Org Mode text into SXML. Supports headlines, metadata, blocks, inline markup, tables, lists, links, and timestamps.

5## Features

7- **Headlines** -- nested levels, TODO/DONE/WAIT/NEXT keywords, priorities, tags

8- **Metadata** -- `#+TITLE:`, `#+AUTHOR:`, and other keywords

9- **Source blocks** -- `#+BEGIN_SRC` with language annotation

10- **Other blocks** -- quote, example, center

11- **Inline markup** -- bold, italic, code, verbatim, underline, strikethrough

12- **Links** -- with or without description text

13- **Lists** -- ordered, unordered, checkboxes

14- **Tables** -- with separator rows and header detection

15- **Timestamps** -- active and inactive

16- **Property drawers** -- key/value metadata on headlines

18## Usage

20Add `sigil-org` as a dependency in your `package.sgl`:

22```scheme

23(from-git url: "codeberg:sigil/sigil-org" package: "sigil-org")

24```

26Then parse Org text:

28```scheme

29(import (sigil org))

31;; Parse a string

32(define doc (org->sxml "* Hello World\nSome text."))

34;; Parse a file

35(define doc (org-file->sxml "notes.org"))

36```

38The result is an SXML document tree compatible with `(sigil sxml)`.

40## Dependencies

42- sigil-stdlib

43- sigil-peg

44- sigil-sxml

46## Building

48```bash

49sigil deps install

50sigil build

51sigil test

52```

54## License

56BSD-3-Clause