Commit4381f4cbRecorded29 Mar 2026Repositorysigil-org
Add README
Changed
README.md | 54 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 54 insertions(+)Diff
README.mdadded
@@ -0,0 +1,54 @@
+1
# sigil-org+2
+3
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.+4
+5
## Features+6
+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+17
+18
## Usage+19
+20
Add `sigil-org` as a dependency in your `package.sgl`:+21
+22
```scheme+23
(from-git url: "codeberg:sigil/sigil-org" package: "sigil-org")+24
```+25
+26
Then parse Org text:+27
+28
```scheme+29
(import (sigil org))+30
+31
;; Parse a string+32
(define doc (org->sxml "* Hello World\nSome text."))+33
+34
;; Parse a file+35
(define doc (org-file->sxml "notes.org"))+36
```+37
+38
The result is an SXML document tree compatible with `(sigil sxml)`.+39
+40
## Dependencies+41
+42
- sigil-stdlib+43
- sigil-peg+44
+45
## Building+46
+47
```bash+48
sigil build --redirects dev-redirects.sgl+49
sigil test+50
```+51
+52
## License+53
+54
BSD-3-Clause