orgmode-parse: A collection of Attoparsec combinators for parsing org-mode flavored documents.

This is a package candidate release! Here you can preview how this package release will appear once published to the main package index (which can be accomplished via the 'maintain' link below). Please note that once a package has been published to the main package index it cannot be undone! Please consult the package uploading documentation for more information.

[maintain]

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]

Properties

Versions0.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.2, 0.3.0
Change logCHANGELOG.md
Dependenciesaeson (>=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]
LicenseBSD-3-Clause
AuthorParnell Springmeyer <parnell@digitalmentat.com>
MaintainerParnell Springmeyer <parnell@digitalmentat.com>
CategoryData
Bug trackerhttps://github.com/ixmatus/orgmode-parse/issues
Source repositoryhead: git clone https://github.com/digitalmentat/orgmode-parse
UploadedThu Oct 11 03:03:25 UTC 2018 by ParnellSpringmeyer

Modules

[Index]

Downloads

Maintainers' corner

For package maintainers and hackage trustees


Readme for orgmode-parse-0.2.2

[back to package description]

Welcome!

Hackage Version Travis CI Status

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:

Parsing org-mode markup is currently being worked on.

What's Planned (outside of what's not finished)

  1. Modernizing this library and adding significantly more documentation to it
  2. Writing a sister library, orgmode-pretty, providing a pretty printer implementation for an org-mode AST
  3. Pandoc integration

Building

There are a few ways to build this library if you're developing a patch:

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

License

BSD3 Open Source Software License