frontmatter 0.1.0.0 → 0.1.0.1

raw patch · 3 files changed

+53/−1 lines, 3 filesPVP ok

version bump matches the API change (PVP)

API changes (from Hackage documentation)

Files

• README.md +45/−0
• changelog.md +5/−0
• frontmatter.cabal +3/−1

@@ -0,0 +1,45 @@+# haskell-frontmatter+[![Build Status](https://travis-ci.org/yamadapc/haskell-frontmatter.svg?branch=master)](https://travis-ci.org/yamadapc/haskell-frontmatter)+[![Hackage Version](https://img.shields.io/hackage/v/frontmatter.svg)](http://hackage.haskell.org/package/frontmatter)+- - -+Attoparsec parsers for YAML frontmatter as used in Jekyll. Because of how+`Data.Yaml` is implemented using `Data.Aeson`, the+`Data.Yaml.Frontmatter.frontmatterYaml` instance of `Parser` works with YAML and+JSON.++## Installation+_This actually won't work right now_+```+$ stack install frontmatter+```++## Usage+```haskell+import Data.Frontmatter+import Data.Yaml (Value)++main = ByteString.readFile "something.md" >>= parseYamlFrontmatter >>= \case+    Done ri fm -> do+        print (fm :: Value) -- aeson object in the frontmatter (the explicit+                            -- type required because the parser will return+                            -- anything with a FromJSON++        putStrLn ri         -- rest of the document+    _ -> error "Parse failure"+```++See the haddocks for more information. Essentially exports an `Attoparsec`+parser and some helpers. Usage examples also available at the `test` directory.++## Why?+I'm working on the Haskell workshop tool+[`workhs`](https://github.com/haskellbr/workhs). In my mind, using markdown file+names as metadata is a very sensible decision. However, I'd like for tutorial+writers to be able to override metadata. Then, Jekyll's YAML frontmatter format+is a great choice:+- It's familiar+- It's very, very easy to implement++## License+This software is published under the MIT license. For more information refer to+the [LICENSE](/LICENSE) file.

@@ -0,0 +1,5 @@+# 0.1.0.1+- Add changelog to hackage package++# 0.1.0.0+Initial version published to hackage

@@ -1,5 +1,5 @@ name:                frontmatter-version:             0.1.0.0+version:             0.1.0.1 synopsis:            Parses frontmatter as used in Jekyll markdown files. description:         Provides a parser that'll parse the frontmatter only and                    . one that'll execute a YAML parser on it, so that it's a@@ -14,6 +14,8 @@ build-type:          Simple cabal-version:       >=1.10 tested-with: GHC >= 7.8+extra-source-files:  changelog.md+                   , README.md  source-repository head   type:     git