orgmode-parse: A collection of Attoparsec combinators for parsing org-mode flavored documents.
`orgmode-parse` is a parsing library for the org-mode flavor of document markup.
The provided Attoparsec combinators parse the human-readable and textual representation into a simple AST for storage or output to another format (HTML? Markdown?).
[Skip to Readme]
Modules
[Index] [Quick Jump]
Downloads
- orgmode-parse-0.2.3.tar.gz [browse] (Cabal source package)
- Package description (as included in the package)
Maintainer's Corner
For package maintainers and hackage trustees
Candidates
| Versions [RSS] | 0.0.0.1, 0.0.0.2, 0.0.0.3, 0.0.1.0, 0.0.1.1, 0.0.1.2, 0.0.2.0, 0.0.2.1, 0.1.0, 0.1.0.1, 0.1.0.2, 0.1.0.3, 0.1.0.4, 0.1.1.0, 0.1.1.1, 0.1.1.2, 0.1.1.3, 0.2.0, 0.2.1, 0.2.2, 0.2.3, 0.3.0 (info) |
|---|---|
| Change log | CHANGELOG.md |
| Dependencies | aeson (>=0.11), attoparsec (>=0.13), base (>=4.8 && <5), bytestring (>=0.10.4), containers (>=0.5.6), free (>=4.9), hashable (>=1.2), old-locale (>=1.0), semigroups, text (>=1.2), thyme (>=0.3), unordered-containers (>=0.2.7) [details] |
| License | BSD-3-Clause |
| Author | Parnell Springmeyer <parnell@digitalmentat.com> |
| Maintainer | Parnell Springmeyer <parnell@digitalmentat.com> |
| Category | Data |
| Bug tracker | https://github.com/ixmatus/orgmode-parse/issues |
| Source repo | head: git clone https://github.com/digitalmentat/orgmode-parse |
| Uploaded | by ParnellSpringmeyer at 2019-11-05T17:39:01Z |
| Distributions | |
| Reverse Dependencies | 2 direct, 0 indirect [details] |
| Downloads | 14823 total (9 in the last 30 days) |
| Rating | (no votes yet) [estimated by Bayesian average] |
| Your Rating | |
| Status | Docs available [build log] Last success reported on 2019-11-05 [all 1 reports] |
Readme for orgmode-parse-0.2.3
[back to package description]Welcome!
orgmode-parse provides a top-level parser and collection of attoparsec parser
combinators for org-mode structured text.
You can find the package on Hackage.
What's Finished
We have built attoparsec parsers for parsing org-mode document structures and meta-data. Here is a list of all the syntax features that have a complete parsing implementation and not:
- Headlines
- State keywords
- Priority indicator
- Title
- Status / progress indicator
- Tag list
- Property drawers
- State keyword changelogs
- Scheduled and deadline timestamps (timestamp, range, duration, periodicity)
- Active and inactive timestamps
- Clock timestamps
- Markup
- Emphasis
- Bold
- Italic
- Strikethrough
- Underline
- Superscript
- Subscript
- Code / monospaced
- Tables
- Lists
- Unordered lists
- Numbered lists
- Checkbox modified lists
- Blocks (src / quote / example blocks)
- Emphasis
Parsing org-mode markup is currently being worked on.
What's Planned (outside of what's not finished)
- Modernizing this library and adding significantly more documentation to it
- Writing a sister library,
orgmode-pretty, providing a pretty printer implementation for an org-mode AST - Pandoc integration
Building
There are a few ways to build this library if you're developing a patch:
stack build && stack test, andnix-build --no-out-link --attr orgmode-parse release.nix
You can also use the nix-shell provided cabal environment for incremental
development:
$ nix-shell --attr orgmode-parse.env release.nix
$ cabal build
Projects that use this package:
https://github.com/volhovm/orgstat