[OCaml] Org mode parser.
docs update README.org for org library rename
README.org
@@ -1,4 +1,4 @@
1
Removed:
#+TITLE: ocaml-org
1
Added:
#+TITLE: org
2
2
#+AUTHOR: Marius PETER
3
3
#+DATE: <2026-08-02 Sun>
4
4
@@ -7,7 +7,7 @@
7
7
8
8
* Overview
9
9
10
Removed:
=ocaml-org= parses Org Mode documents covering approximately 80% of
10
Added:
=org= parses Org Mode documents covering approximately 80% of
11
11
commonly used syntax. It produces a semantic AST suitable for
12
12
downstream consumers such as HTML renderers, document analysis tools,
13
13
and formatters.
@@ -18,25 +18,25 @@
18
18
* Installation
19
19
20
20
#+begin_src sh
21
Removed:
opam install ocaml-org
21
Added:
opam install org
22
22
#+end_src
23
23
24
24
Or add to your =dune-project=:
25
25
26
26
#+begin_src scheme
27
Removed:
(depends (ocaml-org (>= 0.1.0)))
27
Added:
(depends (org (>= 0.1.0)))
28
28
#+end_src
29
29
30
30
* Usage
31
31
32
32
#+begin_src ocaml
33
Removed:
let doc = Ocaml_org.Org.parse {|
34
Removed:
#+TITLE: Hello
35
Removed:
* TODO [#A] First heading :tag1:tag2:
33
Added:
let doc = Org.parse {|
34
Added:
,#+TITLE: Hello
35
Added:
,* TODO [#A] First heading :tag1:tag2:
36
36
Some /italic/ and *bold* text with a [[https://example.com][link]].
37
37
|}
38
38
39
Removed:
(* doc : Ocaml_org.Ast.document *)
39
Added:
(* doc : Org.Ast.document *)
40
40
#+end_src
41
41
42
42
This produces a fully typed AST. Here's what the result looks like:
@@ -105,8 +105,8 @@
105
105
106
106
The public API is minimal:
107
107
108
Removed:
- =Ocaml_org.Org.parse : string -> Ocaml_org.Ast.document=
109
Removed:
- =Ocaml_org.Org.parse_with_diagnostics : string -> Ocaml_org.Ast.document * Ocaml_org.Diagnostic.t list=
108
Added:
- =Org.parse : string -> Org.Ast.document=
109
Added:
- =Org.parse_with_diagnostics : string -> Org.Ast.document * Org.Diagnostic.t list=
110
110
111
111
* Supported Syntax
112
112