Skip to content

Commit

Permalink
Deploy website
Browse files Browse the repository at this point in the history
Deploy website version based on 1334d59
  • Loading branch information
Docusaurus bot committed Sep 23, 2024
1 parent 4b01228 commit 23a6199
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 7 deletions.
4 changes: 2 additions & 2 deletions docs/installation.html
Original file line number Diff line number Diff line change
Expand Up @@ -212,7 +212,7 @@ <h3><a class="anchor" aria-hidden="true" id="configure-site-variables-like-versi
<p>Use <code>--site.VARIABLE=value</code> to add site variables that can be referenced from
markdown as <code>@VARIABLE@</code>.</p>
<pre><code class="hljs css language-diff"> coursier launch org.scalameta:mdoc_2.12:2.6.1 -- \
<span class="hljs-addition">+ --site.SCALA_VERSION 2.12.19</span>
<span class="hljs-addition">+ --site.SCALA_VERSION 2.12.20</span>
</code></pre>
<h3><a class="anchor" aria-hidden="true" id="customize-output-directory"></a><a href="#customize-output-directory" 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>Customize output directory</h3>
<p>Use <code>--out</code> to customize where your markdown sources are generated, by default
Expand Down Expand Up @@ -380,7 +380,7 @@ <h2><a class="anchor" aria-hidden="true" id="library"></a><a href="#library" ari
<p>Add the following dependency to your build</p>
<p><a href="https://maven-badges.herokuapp.com/maven-central/org.scalameta/mdoc_2.12"><img src="https://maven-badges.herokuapp.com/maven-central/org.scalameta/mdoc_2.12/badge.svg" alt="Maven Central"></a></p>
<pre><code class="hljs css language-scala"><span class="hljs-comment">// build.sbt</span>
scalaVersion := <span class="hljs-string">"2.12.19"</span> <span class="hljs-comment">// Any version in 2.12.x works.</span>
scalaVersion := <span class="hljs-string">"2.12.20"</span> <span class="hljs-comment">// Any version in 2.12.x works.</span>
libraryDependencies += <span class="hljs-string">"org.scalameta"</span> %% <span class="hljs-string">"mdoc"</span> % <span class="hljs-string">"2.6.1"</span>
</code></pre>
<p>Then write a main function that invokes mdoc as a library</p>
Expand Down
2 changes: 1 addition & 1 deletion docs/js.html
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ <h3><a class="anchor" aria-hidden="true" id="command-line"></a><a href="#command
configuration</p>
<pre><code class="hljs css language-sh">cat &lt;&lt;EOT &gt; mdoc.properties
js-classpath=$(coursier fetch org.scala-js:scalajs-library_2.12:1.16.0 org.scala-js:scalajs-dom_sjs1_2.12:2.0.0 -p)
js-scalac-options=-Xplugin:$(coursier fetch --intransitive org.scala-js:scalajs-compiler_2.12.19:1.16.0)
js-scalac-options=-Xplugin:$(coursier fetch --intransitive org.scala-js:scalajs-compiler_2.12.20:1.16.0)
js-linker-classpath=$(coursier fetch org.scalameta:mdoc-js-worker_2.12:2.6.1 org.scala-js:scalajs-linker_2.12:1.16.0 -p)
EOT
</code></pre>
Expand Down
4 changes: 2 additions & 2 deletions docs/modifiers.html
Original file line number Diff line number Diff line change
Expand Up @@ -564,9 +564,9 @@ <h2><a class="anchor" aria-hidden="true" id="scastie"></a><a href="#scastie" ari
</code></pre>
<p>After:</p>
<pre><code class="hljs"><span class="hljs-tag">&lt;<span class="hljs-name">script</span> <span class="hljs-attr">src</span>=<span class="hljs-string">"https://scastie.scala-lang.org/embedded.js"</span>&gt;</span><span class="hljs-tag">&lt;/<span class="hljs-name">script</span>&gt;</span>
<span class="hljs-tag">&lt;<span class="hljs-name">pre</span> <span class="hljs-attr">class</span>=<span class="hljs-string">'scastie-snippet-246e7db2-8435-49f9-a7fa-75d112190f83'</span>&gt;</span><span class="hljs-tag">&lt;/<span class="hljs-name">pre</span>&gt;</span>
<span class="hljs-tag">&lt;<span class="hljs-name">pre</span> <span class="hljs-attr">class</span>=<span class="hljs-string">'scastie-snippet-36cf13f0-1210-4a20-a23b-24b4ec570b01'</span>&gt;</span><span class="hljs-tag">&lt;/<span class="hljs-name">pre</span>&gt;</span>
<span class="hljs-tag">&lt;<span class="hljs-name">script</span>&gt;</span><span class="javascript"><span class="hljs-built_in">window</span>.addEventListener(<span class="hljs-string">'load'</span>, <span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params"></span>) </span>{
scastie.Embedded(<span class="hljs-string">'.scastie-snippet-246e7db2-8435-49f9-a7fa-75d112190f83'</span>, {
scastie.Embedded(<span class="hljs-string">'.scastie-snippet-36cf13f0-1210-4a20-a23b-24b4ec570b01'</span>, {
<span class="hljs-attr">code</span>: <span class="hljs-string">`val x = 1 + 2
println(x)`</span>,
<span class="hljs-attr">theme</span>: <span class="hljs-string">'light'</span>,
Expand Down
4 changes: 2 additions & 2 deletions docs/why.html
Original file line number Diff line number Diff line change
Expand Up @@ -226,14 +226,14 @@ <h2><a class="anchor" aria-hidden="true" id="variable-injection"></a><a href="#v
<p>mdoc renders variables like <code>@VERSION@</code> into <code>2.6.1</code>. This makes it easy to
keep documentation up-to-date as new releases are published. Variables can be
passed from the command-line interface with the syntax <code>--site.VARIABLE=value</code>.</p>
<pre><code class="hljs"><span class="hljs-selector-tag">mdoc</span> <span class="hljs-selector-tag">--site</span><span class="hljs-selector-class">.VERSION</span> 1<span class="hljs-selector-class">.0</span><span class="hljs-selector-class">.0</span> <span class="hljs-selector-tag">--site</span><span class="hljs-selector-class">.SCALA_VERSION</span> 2<span class="hljs-selector-class">.12</span><span class="hljs-selector-class">.19</span>
<pre><code class="hljs"><span class="hljs-selector-tag">mdoc</span> <span class="hljs-selector-tag">--site</span><span class="hljs-selector-class">.VERSION</span> 1<span class="hljs-selector-class">.0</span><span class="hljs-selector-class">.0</span> <span class="hljs-selector-tag">--site</span><span class="hljs-selector-class">.SCALA_VERSION</span> 2<span class="hljs-selector-class">.12</span><span class="hljs-selector-class">.20</span>
</code></pre>
<p>When using the library API, variables are passed with the
<code>MainSettings.withSiteVariables(Map[String, String])</code> method</p>
<pre><code class="hljs css language-diff"> val settings = mdoc.MainSettings()
<span class="hljs-addition">+ .withSiteVariables(Map(</span>
<span class="hljs-addition">+ "VERSION" -&gt; "1.0.0",</span>
<span class="hljs-addition">+ "SCALA_VERSION" -&gt; "2.12.19"</span>
<span class="hljs-addition">+ "SCALA_VERSION" -&gt; "2.12.20"</span>
<span class="hljs-addition">+ ))</span>
</code></pre>
<p>When using sbt-mdoc, variables are defined with the <code>mdocVariables</code> setting.</p>
Expand Down

0 comments on commit 23a6199

Please sign in to comment.