diff --git a/docs/contributing.html b/docs/contributing.html index 43194a64..76afde93 100644 --- a/docs/contributing.html +++ b/docs/contributing.html @@ -1,4 +1,4 @@ -Contributing guide
Scala-yaml
0.0.0+1-41b15eb2-SNAPSHOT
DocsAPI
Generated with
Copyright (c) 2021, VirtusLab
Copyright (c) 2021, VirtusLab
Scala-yaml/Contributing guide
+Contributing guide
Scala-yaml
0.0.0+1-74c2c47a-SNAPSHOT
DocsAPI
Generated with
Copyright (c) 2021, VirtusLab
Copyright (c) 2021, VirtusLab
Scala-yaml/Contributing guide

Run unit tests

$ sbt test
diff --git a/docs/examples.html b/docs/examples.html
index 2a968411..682b02d4 100644
--- a/docs/examples.html
+++ b/docs/examples.html
@@ -1,5 +1,5 @@
-Examples
Scala-yaml
0.0.0+1-41b15eb2-SNAPSHOT
DocsAPI
Generated with
Copyright (c) 2021, VirtusLab
Copyright (c) 2021, VirtusLab
Scala-yaml/Examples

- 
Supported types

+Examples
Scala-yaml
0.0.0+1-74c2c47a-SNAPSHOT
DocsAPI
Generated with
Copyright (c) 2021, VirtusLab
Copyright (c) 2021, VirtusLab
Scala-yaml/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
-
Generated with
Copyright (c) 2021, VirtusLab
Copyright (c) 2021, VirtusLab
\ No newline at end of file +
Generated with
Copyright (c) 2021, VirtusLab
Copyright (c) 2021, VirtusLab
\ No newline at end of file diff --git a/docs/index.html b/docs/index.html index bbf6a8ec..878ff26c 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,5 +1,5 @@ -Scala-yaml
Scala-yaml
0.0.0+1-41b15eb2-SNAPSHOT
DocsAPI
Generated with
Copyright (c) 2021, VirtusLab
Copyright (c) 2021, VirtusLab
Scala-yaml
-

Scala Yaml

+Scala-yaml
Scala-yaml
0.0.0+1-74c2c47a-SNAPSHOT
DocsAPI
Generated with
Copyright (c) 2021, VirtusLab
Copyright (c) 2021, VirtusLab
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
-
Generated with
Copyright (c) 2021, VirtusLab
Copyright (c) 2021, VirtusLab
\ No newline at end of file +
Generated with
Copyright (c) 2021, VirtusLab
Copyright (c) 2021, VirtusLab
\ No newline at end of file diff --git a/docs/quickstart.html b/docs/quickstart.html index b19336fe..1445b827 100644 --- a/docs/quickstart.html +++ b/docs/quickstart.html @@ -1,4 +1,4 @@ -Quick start
Scala-yaml
0.0.0+1-41b15eb2-SNAPSHOT
DocsAPI
Generated with
Copyright (c) 2021, VirtusLab
Copyright (c) 2021, VirtusLab
Scala-yaml/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
Scala-yaml
0.0.0+1-74c2c47a-SNAPSHOT
DocsAPI
Generated with
Copyright (c) 2021, VirtusLab
Copyright (c) 2021, VirtusLab
Scala-yaml/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: