Skip to content
Antoine Aubry edited this page Jul 17, 2019 · 6 revisions

YamlDotNet is a .NET library for YAML. YamlDotNet provides low level parsing and emitting of YAML as well as a high level object model similar to XmlDocument. A serialization library is also included that allows to read and write objects from and to YAML streams.

Currently, YamlDotNet supports version 1.1 of the YAML specification.

What is YAML?

YAML, which stands for "YAML Ain't Markup Language", is described as "a human friendly data serialization standard for all programming languages". Like XML, it allows to represent about any kind of data in a portable, platform-independent format. Unlike XML, it is "human friendly", which means that it is easy for a human to read or produce a valid YAML document.

The YamlDotNet library

The library has now been successfully used in multiple projects and is considered fairly stable.

Installing

Just install the YamlDotNet NuGet package:

PM> Install-Package YamlDotNet

If you need signed assemblies, install the YamlDotNet.Signed NuGet package instead:

PM> Install-Package YamlDotNet.Signed

YamlDotNet is also available on the Unity Asset Store.

There is also a continuous integration project configured on AppVeyor where you can download the binaries:

License

The software is released under the MIT License. Before using this software, you should read the license, but basically, you are allowed to use the code in any kind of project, commercial or not, provided that you redistribute the license with the software.

If you use this software, I will apreciate if you let me know, but that is not a requirement.

Documentation

The documentation is a work in progress. Here is what is currently covered:

The samples page contains some code samples that illustrate how to use the library for various use cases.

Usage questions about YamlDotNet should be asked on StackOverflow, and tagged with yamldotnet.

A list of selected questions can be consulted in Frequently Asked Questions.

You can’t perform that action at this time.