yaml: Support for parsing and rendering YAML documents.
README and API documentation are available at https://www.stackage.org/package/yaml
[Skip to Readme]
Modules
[Index] [Quick Jump]
Flags
Automatic Flags
| Name | Description | Default |
|---|---|---|
| no-examples | don't build the examples | Enabled |
| no-exe | don't install the yaml2json or json2yaml executables | Enabled |
| no-unicode | Don't enable unicode output. Instead, unicode characters will be escaped. | Disabled |
| system-libyaml | Use the system-wide libyaml instead of the bundled copy | Disabled |
Use -f <flag> to enable a flag, or -f -<flag> to disable that flag. More info
Downloads
- yaml-0.10.1.1.tar.gz [browse] (Cabal source package)
- Package description (revised from the package)
Note: This package has metadata revisions in the cabal description newer than included in the tarball. To unpack the package including the revisions, use 'cabal get'.
Maintainer's Corner
For package maintainers and hackage trustees
Candidates
- No Candidates
Readme for yaml-0.10.1.1
[back to package description]yaml
Provides support for parsing and emitting Yaml documents.
This package includes the full libyaml C library version 0.2.1 by Kirill Simonov in the package so you don't need to worry about any non-Haskell dependencies.
The package is broken down into two primary modules. Data.Yaml provides a high-level interface based around the JSON datatypes provided by the aeson package. Text.Libyaml provides a lower-level, streaming interface. For most users, Data.Yaml is recommended.
Examples
Usage examples can be found in the Data.Yaml documentation or in the examples directory.
Additional modules
Data.Yaml.Includesupports adding!includedirectives to your YAML files.Data.Yaml.BuilderandData.Yaml.Parserallow more fine-grained control of parsing an rendering, as opposed to just using the aeson typeclass and datatype system for parsing and rendering.Data.Yaml.Aesonis currently a re-export ofData.Yamlto explicitly choose to use the aeson-compatible API.