Skip to content

Commit

Permalink
Deploy website
Browse files Browse the repository at this point in the history
Deploy website version based on 684561f
  • Loading branch information
Docusaurus bot committed Sep 6, 2024
1 parent 0f8e1cb commit 7cf0ba5
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion docs/getting-started.html
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@
classes, just like HOCON and JSON configuration.</li>
</ul>
<h2><a class="anchor" aria-hidden="true" id="quick-start"></a><a href="#quick-start" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Quick start</h2>
<pre><code class="hljs css language-scala">libraryDependencies += <span class="hljs-string">"org.scalameta"</span> %% <span class="hljs-string">"metaconfig-typesafe-config"</span> % <span class="hljs-string">"0.13.0-14-7e97ad9f-SNAPSHOT"</span>
<pre><code class="hljs css language-scala">libraryDependencies += <span class="hljs-string">"org.scalameta"</span> %% <span class="hljs-string">"metaconfig-typesafe-config"</span> % <span class="hljs-string">"0.13.0-16-684561ff-SNAPSHOT"</span>
</code></pre>
<p>Next, write a case class for your user configuration.</p>
<pre><code class="hljs css language-scala"><span class="hljs-keyword">import</span> metaconfig._
Expand Down
10 changes: 5 additions & 5 deletions docs/reference.html
Original file line number Diff line number Diff line change
Expand Up @@ -83,10 +83,10 @@
<li><a href="https://github.com/pureconfig/pureconfig">https://github.com/pureconfig/pureconfig</a></li>
</ul>
<h2><a class="anchor" aria-hidden="true" id="getting-started"></a><a href="#getting-started" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Getting started</h2>
<pre><code class="hljs css language-scala">libraryDependencies += <span class="hljs-string">"org.scalameta"</span> %% <span class="hljs-string">"metaconfig-core"</span> % <span class="hljs-string">"0.13.0-14-7e97ad9f-SNAPSHOT"</span>
<pre><code class="hljs css language-scala">libraryDependencies += <span class="hljs-string">"org.scalameta"</span> %% <span class="hljs-string">"metaconfig-core"</span> % <span class="hljs-string">"0.13.0-16-684561ff-SNAPSHOT"</span>

<span class="hljs-comment">// Use https://github.com/lightbend/config to parse HOCON</span>
libraryDependencies += <span class="hljs-string">"org.scalameta"</span> %% <span class="hljs-string">"metaconfig-typesafe-config"</span> % <span class="hljs-string">"0.13.0-14-7e97ad9f-SNAPSHOT"</span>
libraryDependencies += <span class="hljs-string">"org.scalameta"</span> %% <span class="hljs-string">"metaconfig-typesafe-config"</span> % <span class="hljs-string">"0.13.0-16-684561ff-SNAPSHOT"</span>
</code></pre>
<p>Use this import to access the metaconfig API</p>
<pre><code class="hljs css language-scala"><span class="hljs-keyword">import</span> metaconfig._
Expand Down Expand Up @@ -319,7 +319,7 @@ <h2><a class="anchor" aria-hidden="true" id="confdecoder"></a><a href="#confdeco
<span class="hljs-keyword">if</span> (file.exists()) <span class="hljs-type">Configured</span>.ok(file)
<span class="hljs-keyword">else</span> <span class="hljs-type">ConfError</span>.fileDoesNotExist(file).notOk
}
<span class="hljs-comment">// fileDecoder: ConfDecoder[java.io.File] = metaconfig.ConfDecoder$$anonfun$flatMap$2@3d347c6a</span>
<span class="hljs-comment">// fileDecoder: ConfDecoder[java.io.File] = metaconfig.ConfDecoder$$anonfun$flatMap$2@39e2d8aa</span>
fileDecoder.read(<span class="hljs-type">Conf</span>.fromString(<span class="hljs-string">".scalafmt.conf"</span>))
<span class="hljs-comment">// res11: Configured[java.io.File] = Ok(value = .scalafmt.conf)</span>
fileDecoder.read(<span class="hljs-type">Conf</span>.fromString(<span class="hljs-string">".foobar"</span>))
Expand Down Expand Up @@ -362,7 +362,7 @@ <h2><a class="anchor" aria-hidden="true" id="confencoder"></a><a href="#confenco
automatically derive a <code>ConfEncoder[T]</code> instance for any case class with
<code>generic.deriveEncoder</code>.</p>
<pre><code class="hljs css language-scala"><span class="hljs-keyword">implicit</span> <span class="hljs-keyword">val</span> encoder: <span class="hljs-type">ConfEncoder</span>[<span class="hljs-type">User</span>] = generic.deriveEncoder[<span class="hljs-type">User</span>]
<span class="hljs-comment">// encoder: ConfEncoder[User] = repl.MdocSession$MdocApp$$anon$1@67cc5304</span>
<span class="hljs-comment">// encoder: ConfEncoder[User] = repl.MdocSession$MdocApp$$anon$1@11fcfe6a</span>

<span class="hljs-type">ConfEncoder</span>[<span class="hljs-type">User</span>].write(<span class="hljs-type">User</span>(<span class="hljs-string">"John"</span>, <span class="hljs-number">42</span>))
<span class="hljs-comment">// res13: Conf = Obj(</span>
Expand Down Expand Up @@ -715,7 +715,7 @@ <h2><a class="anchor" aria-hidden="true" id="inline"></a><a href="#inline" aria-
<h2><a class="anchor" aria-hidden="true" id="docs"></a><a href="#docs" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Docs</h2>
<p>To generate documentation for you configuration, add a dependency to the
following module</p>
<pre><code class="hljs css language-scala">libraryDependencies += <span class="hljs-string">"org.scalameta"</span> %% <span class="hljs-string">"metaconfig-docs"</span> % <span class="hljs-string">"0.13.0-14-7e97ad9f-SNAPSHOT"</span>
<pre><code class="hljs css language-scala">libraryDependencies += <span class="hljs-string">"org.scalameta"</span> %% <span class="hljs-string">"metaconfig-docs"</span> % <span class="hljs-string">"0.13.0-16-684561ff-SNAPSHOT"</span>
</code></pre>
<p>First define your configuration</p>
<pre><code class="hljs css language-scala"><span class="hljs-keyword">import</span> metaconfig._
Expand Down

0 comments on commit 7cf0ba5

Please sign in to comment.