Skip to content

Commit c4bfe09

Browse files
committed
Update readme
1 parent 239fd3d commit c4bfe09

1 file changed

Lines changed: 20 additions & 8 deletions

File tree

README.md

Lines changed: 20 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -22,12 +22,19 @@ print(doc.children[0].headline.keyword); // TODO
2222

2323
See the [example](./example/example.dart) for more.
2424

25-
# Caveats
26-
27-
This parser was developed for an application that is halfway between
28-
pretty-printing and evaluating/interpreting, so in many cases the parsed
29-
structure does not split out constituent parts as thoroughly as needed for some
30-
applications.
25+
# Features
26+
27+
- [Parser](./lib/src/org/parser.dart) and rich, immutable AST for Org markup
28+
- [Zipper](https://en.wikipedia.org/wiki/Zipper_(data_structure))-based editing
29+
facilities for Org AST
30+
- Extensive test suite, including checks for lossless round-tripping from markup
31+
to AST and back
32+
- [Parser](./lib/src/query/parser.dart) for the [headline matching
33+
DSL](https://orgmode.org/manual/Matching-tags-and-properties.html)
34+
- [Parser](./lib/src/file_link/parser.dart) for [file
35+
links](https://orgmode.org/manual/Search-Options.html)
36+
- [Parser](./lib/src/todo/parser.dart) for and extended handling of the [TODO
37+
workflow DSL](https://orgmode.org/manual/Workflow-states.html)
3138

3239
# Supported syntax
3340

@@ -73,6 +80,7 @@ applications.
7380
- [X] bar
7481
1. baz
7582
2. buzz
83+
- bazinga :: bazonga
7684
```
7785
- Drawers
7886
@@ -88,14 +96,16 @@ applications.
8896
8997
[fn:1] Bazinga
9098
```
91-
- Links
99+
- Links, *including with emphasis in description*
92100
93101
```org
94102
[[http://example.com][example]]
95103
104+
[[http://example.com][example *with* emphasis]]
105+
96106
http://example.com
97107
```
98-
- Emphasis markup
108+
- Emphasis markup, *including nested emphasis*
99109
100110
```org
101111
*bold* /italic/ _underline_ +strikethrough+ ~code~ =verbatim=
@@ -106,6 +116,8 @@ applications.
106116
[2020-05-05 Tue]
107117
108118
<2020-05-05 Tue 10:00>
119+
120+
[2020-05-05 Tue]--[2020-05-05 Tue]
109121
```
110122
- Macro references
111123

0 commit comments

Comments
 (0)