org_parser

KO | EN

gitlite — search

#hacktoberfest #react #llm #golang #android #deep-learning #nodejs #awesome #cli #kubernetes #awesome-list #vue #security #mcp

(★ 51)

An Org Mode parser for Dart

File Explorer

Download Latest Version (.zip)

- - dart.yml
- example.dart
- pretty.dart
- - search.dart
- org_parser.dart
- - roundtrip.dart
- - grammar_test.dart
  - model_test.dart
  - parser_test.dart
- - grammar_test.dart
  - matchers.dart
  - model_test.dart
  - parser_test.dart
- edit_test.dart
- example-gold.txt
- matchers.dart
- org-manual.org
- org-syntax.org
- plist_test.dart
- profile.dart
- search_test.dart
- todo_test.dart
- util_test.dart
.gitignore
.metadata
analysis_options.yaml
CHANGELOG.md
LICENSE
Makefile
pubspec.lock
pubspec.yaml
README.md

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# org_parser

An [Org Mode](https://orgmode.org/) parser for Dart.

# Usage

For displaying Org Mode documents in Flutter applications, see
[org_flutter](https://github.com/amake/org_flutter). For an example application
that displays Org Mode documents with org_parser and org_flutter, see
[Orgro](https://orgro.org).

This package allows you to parse raw Org Mode documents into a structured
in-memory representation.

```dart
import 'package:org_parser/org_parser.dart';

final doc = OrgDocument.parse('''* TODO [#A] foo bar
baz buzz''');
print(doc.children[0].headline.keyword); // TODO
```

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

# Features

- [Parser](./lib/src/org/parser.dart) and rich, immutable AST for Org markup
- [Zipper](https://en.wikipedia.org/wiki/Zipper_(data_structure))-based editing
  facilities for Org AST
- Extensive test suite, including checks for lossless round-tripping from markup
  to AST and back
- [Parser](./lib/src/query/parser.dart) for the [headline matching
  DSL](https://orgmode.org/manual/Matching-tags-and-properties.html)
- [Parser](./lib/src/file_link/parser.dart) for [file
  links](https://orgmode.org/manual/Search-Options.html)
- [Parser](./lib/src/todo/parser.dart) for and extended handling of the [TODO
  workflow DSL](https://orgmode.org/manual/Workflow-states.html)

# Supported syntax

- Sections/headlines

```org
    * TODO [#A] foo bar
    ```
- Blocks

```org
    #+BEGIN_SRC
    foo bar
    #+END_SRC
    ```
- Inline src

```org
    foo src_sh{echo "bar"} baz
    ```
- Affiliated keywords

```org
    #+name: foo
    ```
- Fixed-width areas

```org
    : foo bar
    : baz buzz
    ```
- Tables

```org
    | foo | bar |
    |-----+-----|
    | biz | baz |
    ```
- Lists

```org
    - foo
      - [X] bar
        1. baz
        2. buzz
    - bazinga :: bazonga
    ```
- Drawers

```org
    :PROPERTIES:
    foo bar
    :END:
    ```
- Footnotes

```org
    Foo bar[fn:1] biz buzz

[fn:1] Bazinga
    ```
- Links, *including with emphasis in description*

```org
    [[http://example.com][example]]

[[http://example.com][example *with* emphasis]]

http://example.com
    ```
- Emphasis markup, *including nested emphasis*

```org
    *bold* /italic/ _underline_ +strikethrough+ ~code~ =verbatim=
    ```
- Timestamps

```org
    [2020-05-05 Tue]

<2020-05-05 Tue 10:00>

[2020-05-05 Tue]--[2020-05-05 Tue]
    ```
- Macro references

```org
    {{{kbd(C-c C-c)}}}
    ```

- LaTeX fragments

```org
    Then we add $a^2$ to $b^2$
    ```

```org
    \begin{equation}
    \nabla \times \mathbf{B} = \frac{1}{c}\left( 4\pi\mathbf{J} + \frac{\partial \mathbf{E}}{\partial t}\right)
    \end{equation}
    ```

- Entities

```org
    a\leftrightarrow{}b conversion
    ```

- Citations

```org
    [cite:@key]
    ```

- Horizontal rules

```org
    -----
    ```
- Radio targets

```org
    <<<foo>>>
    ```

- Link targets

```org
    <<bar>>
    ```

org_parser

File Explorer

Today's picks

Was this content helpful?

Recent Feedback

org_parser

File Explorer

Today's picks

Was this content helpful?

Recent Feedback

Download README