diff --git a/docs/contributing.html b/docs/contributing.html index 0c13deb7..78b3c581 100644 --- a/docs/contributing.html +++ b/docs/contributing.html @@ -1,16 +1,16 @@ -Contributing guide
-

Run unit tests

+Contributing guide
+

Run unit tests

$ sbt test
 
-
-

Run integration tests

+
+

Run integration tests

$ sbt IntegrationTest/test
 
-
\ No newline at end of file +
\ No newline at end of file diff --git a/docs/examples.html b/docs/examples.html index 75ee977f..48bc7122 100644 --- a/docs/examples.html +++ b/docs/examples.html @@ -1,5 +1,5 @@ -Examples
-

Supported types

+Examples
+

Supported types

Scala-yaml has built-in support for:

  • all primitive types
  • @@ -7,8 +7,8 @@

    Supported types
  • collections from stdlib
-
-

Primitives

+
+

Primitives

import org.virtuslab.yaml.*
 
@@ -21,8 +21,8 @@ 

Primitives

-
-

Option

+
+

Option

When deserializing, YAML differentiates between empty string and null value. Hence in the following yaml

key1: ""
@@ -45,8 +45,8 @@ 

Option

-
-

List

+
+

List

import org.virtuslab.yaml.*
 
@@ -65,8 +65,8 @@ 

List

-
-

Map

+
+

Map

import org.virtuslab.yaml.*
 
@@ -79,8 +79,8 @@ 

Map

-
-

Decoding from unknown type

+
+

Decoding from unknown type

It is also possible to decode yaml of unknown type. Since yaml consists of: scalars, mappings and sequences one can use:

  • as[Any] - it will decode yaml into List or Map depending on its structure
  • @@ -116,4 +116,4 @@

    Deco

-
\ No newline at end of file + \ No newline at end of file diff --git a/docs/index.html b/docs/index.html index eeef19ed..b5c518c9 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,5 +1,5 @@ -Scala-yaml
-

Scala Yaml

+Scala-yaml
+

Scala Yaml

Example

Scala Yaml is written in Scala, dependency-free library that allows to work with the YAML.

The goal of this project is to create idiomatic library which:

@@ -11,12 +11,12 @@

Scala Yaml

Please see the guide for more information

-
-

Help us create our roadmap!

+
+

Help us create our roadmap!

Take part in our discussions, post your ideas, vote for feature requests and have a real impact on how our next milestone will look like!

-
-

Usage

+
+

Usage

import org.virtuslab.yaml.*
 
@@ -45,4 +45,4 @@ 

Usage

-
\ No newline at end of file +
\ No newline at end of file diff --git a/docs/quickstart.html b/docs/quickstart.html index 413384c0..9c87c7c5 100644 --- a/docs/quickstart.html +++ b/docs/quickstart.html @@ -1,4 +1,4 @@ -Quick start

Using scala-yaml is very easy, all you have to do is import org.virtuslab.yaml.* and write derives YamlCodec after your case class definition. Then you're able to use following extension methods:

+Quick start

Using scala-yaml is very easy, all you have to do is import org.virtuslab.yaml.* and write derives YamlCodec after your case class definition. Then you're able to use following extension methods: