Skip to content

Commit

Permalink
chore(docs): Update code snippets in HTML files
Browse files Browse the repository at this point in the history
This commit updates code snippets in HTML files to improve readability
and consistency across the documentation.
- Updated the syntax highlighting for Clojure, Gradle, XML, Bash, and CMD
code snippets for better visibility.
- Added CSS classes to the code blocks for proper styling.
- Enhanced the structure and formatting of the code blocks for better
comprehension.
- Introduced division elements with proper CSS classes to separate the
code snippets cleanly.
- The changes aim to enhance the overall user experience and
understandability of the code examples.
  • Loading branch information
AdaiasMagdiel committed Mar 13, 2024
1 parent 4bb3b64 commit d21165f
Show file tree
Hide file tree
Showing 5 changed files with 73 additions and 73 deletions.
2 changes: 1 addition & 1 deletion docs/404.html
Original file line number Diff line number Diff line change
Expand Up @@ -298,7 +298,7 @@ <h1>404 - Not found</h1>
</div>


<script id="__config" type="application/json">{"base": "/", "features": [], "search": "/assets/javascripts/workers/search.b8dbb3d2.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
<script id="__config" type="application/json">{"base": "/", "features": ["navigation.sections", "navigation.path", "content.code.copy"], "search": "/assets/javascripts/workers/search.b8dbb3d2.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>


<script src="/assets/javascripts/bundle.c8d2eff1.min.js"></script>
Expand Down
38 changes: 19 additions & 19 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -595,27 +595,27 @@ <h2 id="installation">Installation</h2>
<p><a name="leiningenboot"></a></p>
<h3 id="leiningenboot">Leiningen/Boot</h3>
<p>Add the following dependency to your <code>project.clj</code>:</p>
<pre><code class="language-clojure">[com.adaiasmagdiel/deta &quot;0.0.3&quot;]
</code></pre>
<div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="p">[</span><span class="nv">com.adaiasmagdiel/deta</span><span class="w"> </span><span class="s">&quot;0.0.3&quot;</span><span class="p">]</span>
</code></pre></div>
<p><a name="clojure-clidepsedn"></a></p>
<h3 id="clojure-clidepsedn">Clojure CLI/deps.edn</h3>
<p>Add the following dependency to your <code>deps.edn</code>:</p>
<pre><code class="language-clojure">com.adaiasmagdiel/deta {:mvn/version &quot;0.0.3&quot;}
</code></pre>
<div class="highlight"><pre><span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a><span class="nv">com.adaiasmagdiel/deta</span><span class="w"> </span><span class="p">{</span><span class="ss">:mvn/version</span><span class="w"> </span><span class="s">&quot;0.0.3&quot;</span><span class="p">}</span>
</code></pre></div>
<p><a name="gradle"></a></p>
<h3 id="gradle">Gradle</h3>
<p>Add the following dependency to your <code>build.gradle</code>:</p>
<pre><code class="language-gradle">implementation(&quot;com.adaiasmagdiel:deta:0.0.3&quot;)
</code></pre>
<div class="highlight"><pre><span></span><code><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a>implementation(&quot;com.adaiasmagdiel:deta:0.0.3&quot;)
</code></pre></div>
<p><a name="maven"></a></p>
<h3 id="maven">Maven</h3>
<p>Add the following dependency to your <code>pom.xml</code>:</p>
<pre><code class="language-xml">&lt;dependency&gt;
&lt;groupId&gt;com.adaiasmagdiel&lt;/groupId&gt;
&lt;artifactId&gt;deta&lt;/artifactId&gt;
&lt;version&gt;0.0.3&lt;/version&gt;
&lt;/dependency&gt;
</code></pre>
<div class="highlight"><pre><span></span><code><a id="__codelineno-3-1" name="__codelineno-3-1" href="#__codelineno-3-1"></a><span class="nt">&lt;dependency&gt;</span>
<a id="__codelineno-3-2" name="__codelineno-3-2" href="#__codelineno-3-2"></a><span class="w"> </span><span class="nt">&lt;groupId&gt;</span>com.adaiasmagdiel<span class="nt">&lt;/groupId&gt;</span>
<a id="__codelineno-3-3" name="__codelineno-3-3" href="#__codelineno-3-3"></a><span class="w"> </span><span class="nt">&lt;artifactId&gt;</span>deta<span class="nt">&lt;/artifactId&gt;</span>
<a id="__codelineno-3-4" name="__codelineno-3-4" href="#__codelineno-3-4"></a><span class="w"> </span><span class="nt">&lt;version&gt;</span>0.0.3<span class="nt">&lt;/version&gt;</span>
<a id="__codelineno-3-5" name="__codelineno-3-5" href="#__codelineno-3-5"></a><span class="nt">&lt;/dependency&gt;</span>
</code></pre></div>
<p><a name="tests"></a></p>
<h2 id="tests">Tests</h2>
<p>The <code>deta.base-test</code> namespace includes tests for the <code>base</code> and <code>put</code> functions. These tests cover various scenarios, including valid and invalid <code>deta-key</code> inputs, different data types for the <code>put</code> function, and the behavior of the <code>put</code> function when a key is provided.</p>
Expand All @@ -624,14 +624,14 @@ <h3 id="running-tests">Running Tests</h3>
<p>To run the tests, set the <code>DETA_KEY</code> environment variable to a valid Deta key beforehand.</p>
<p><a name="windows"></a></p>
<h3 id="windows">Windows</h3>
<pre><code class="language-cmd">set DETA_KEY=your_deta_key_here
lein test
</code></pre>
<div class="highlight"><pre><span></span><code><a id="__codelineno-4-1" name="__codelineno-4-1" href="#__codelineno-4-1"></a>set DETA_KEY=your_deta_key_here
<a id="__codelineno-4-2" name="__codelineno-4-2" href="#__codelineno-4-2"></a>lein test
</code></pre></div>
<p><a name="linuxmacos"></a></p>
<h3 id="linuxmacos">Linux/MacOS</h3>
<pre><code class="language-bash">export DETA_KEY=your_deta_key_here
lein test
</code></pre>
<div class="highlight"><pre><span></span><code><a id="__codelineno-5-1" name="__codelineno-5-1" href="#__codelineno-5-1"></a><span class="nb">export</span><span class="w"> </span><span class="nv">DETA_KEY</span><span class="o">=</span>your_deta_key_here
<a id="__codelineno-5-2" name="__codelineno-5-2" href="#__codelineno-5-2"></a>lein<span class="w"> </span><span class="nb">test</span>
</code></pre></div>
<p>Replace <code>your_deta_key_here</code> with your actual Deta key.</p>


Expand Down Expand Up @@ -679,7 +679,7 @@ <h3 id="linuxmacos">Linux/MacOS</h3>
</div>


<script id="__config" type="application/json">{"base": ".", "features": [], "search": "assets/javascripts/workers/search.b8dbb3d2.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
<script id="__config" type="application/json">{"base": ".", "features": ["navigation.sections", "navigation.path", "content.code.copy"], "search": "assets/javascripts/workers/search.b8dbb3d2.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>


<script src="assets/javascripts/bundle.c8d2eff1.min.js"></script>
Expand Down
26 changes: 13 additions & 13 deletions docs/reference/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -444,42 +444,42 @@ <h2 id="table-of-contents">Table of Contents</h2>
</ul>
<p><a name="base"></a></p>
<h2 id="base">Base</h2>
<pre><code class="language-clojure">(base/base deta-key basename)
</code></pre>
<div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="p">(</span><span class="nf">base/base</span><span class="w"> </span><span class="nv">deta-key</span><span class="w"> </span><span class="nv">basename</span><span class="p">)</span>
</code></pre></div>
<ul>
<li><strong>Return:</strong> Database connection object.</li>
<li><strong>Exceptions:</strong> If <code>deta-key</code> is invalid or not provided.</li>
</ul>
<p><a name="put"></a></p>
<h2 id="put">Put</h2>
<pre><code class="language-clojure">(base/put db data)
(base/put db data key)
</code></pre>
<div class="highlight"><pre><span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a><span class="p">(</span><span class="nf">base/put</span><span class="w"> </span><span class="nv">db</span><span class="w"> </span><span class="nv">data</span><span class="p">)</span>
<a id="__codelineno-1-2" name="__codelineno-1-2" href="#__codelineno-1-2"></a><span class="p">(</span><span class="nf">base/put</span><span class="w"> </span><span class="nv">db</span><span class="w"> </span><span class="nv">data</span><span class="w"> </span><span class="nv">key</span><span class="p">)</span>
</code></pre></div>
<ul>
<li><strong>Return:</strong> Map containing the inserted data and the generated key (if not provided).</li>
<li><strong>Exceptions:</strong> If data type is not supported, or if <code>deta-key</code> is invalid or not provided.</li>
</ul>
<p><a name="get"></a></p>
<h2 id="get">Get</h2>
<pre><code class="language-clojure">(base/get db key)
</code></pre>
<div class="highlight"><pre><span></span><code><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a><span class="p">(</span><span class="nf">base/get</span><span class="w"> </span><span class="nv">db</span><span class="w"> </span><span class="nv">key</span><span class="p">)</span>
</code></pre></div>
<ul>
<li><strong>Return:</strong> Retrieved data as a map if the key exists, or <code>nil</code> if the key does not exist or an error occurs.</li>
<li><strong>Exceptions:</strong> If <code>key</code> is not provided or is empty.</li>
</ul>
<p><a name="delete"></a></p>
<h2 id="delete">Delete</h2>
<pre><code class="language-clojure">(base/delete db key)
</code></pre>
<div class="highlight"><pre><span></span><code><a id="__codelineno-3-1" name="__codelineno-3-1" href="#__codelineno-3-1"></a><span class="p">(</span><span class="nf">base/delete</span><span class="w"> </span><span class="nv">db</span><span class="w"> </span><span class="nv">key</span><span class="p">)</span>
</code></pre></div>
<ul>
<li><strong>Return:</strong> <code>nil</code>. The function does not return a meaningful value as its purpose is to remove an item from the database.</li>
<li><strong>Exceptions:</strong> Throws an <code>Exception</code> if the key is not provided or is empty.</li>
</ul>
<p><a name="insert"></a></p>
<h2 id="insert">Insert</h2>
<pre><code class="language-clojure">(base/insert db data)
(base/insert db data key)
</code></pre>
<div class="highlight"><pre><span></span><code><a id="__codelineno-4-1" name="__codelineno-4-1" href="#__codelineno-4-1"></a><span class="p">(</span><span class="nf">base/insert</span><span class="w"> </span><span class="nv">db</span><span class="w"> </span><span class="nv">data</span><span class="p">)</span>
<a id="__codelineno-4-2" name="__codelineno-4-2" href="#__codelineno-4-2"></a><span class="p">(</span><span class="nf">base/insert</span><span class="w"> </span><span class="nv">db</span><span class="w"> </span><span class="nv">data</span><span class="w"> </span><span class="nv">key</span><span class="p">)</span>
</code></pre></div>
<ul>
<li><strong>Return:</strong> Map containing the inserted data and the generated key (if not provided).</li>
<li><strong>Exceptions:</strong> Throws an <code>Exception</code> if the data type is not supported, or if <code>deta-key</code> is invalid or not provided, or if an item with the provided key already exists.</li>
Expand Down Expand Up @@ -530,7 +530,7 @@ <h2 id="insert">Insert</h2>
</div>


<script id="__config" type="application/json">{"base": "..", "features": [], "search": "../assets/javascripts/workers/search.b8dbb3d2.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
<script id="__config" type="application/json">{"base": "..", "features": ["navigation.sections", "navigation.path", "content.code.copy"], "search": "../assets/javascripts/workers/search.b8dbb3d2.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>


<script src="../assets/javascripts/bundle.c8d2eff1.min.js"></script>
Expand Down
Binary file modified docs/sitemap.xml.gz
Binary file not shown.
Loading

0 comments on commit d21165f

Please sign in to comment.