Skip to content

Commit

Permalink
deploy: 8671b2f
Browse files Browse the repository at this point in the history
  • Loading branch information
@kojix2
kojix2 committed Aug 11, 2024
1 parent 13c6929 commit 8629c75
Show file tree
Hide file tree
Showing 4 changed files with 35 additions and 19 deletions.
14 changes: 7 additions & 7 deletions Wombat.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -102,21 +102,21 @@ <h2>
</h2>


<a href="https://github.com/kojix2/wombat/blob/92744c82f7327041bac83eb475010c8c51934f22/src/wombat.cr#L4" target="_blank">
<a href="https://github.com/kojix2/wombat/blob/8671b2fe37f333406cad773fe0d77fadb030da62/src/wombat.cr#L4" target="_blank">
wombat.cr
</a>

<br/>


<a href="https://github.com/kojix2/wombat/blob/92744c82f7327041bac83eb475010c8c51934f22/src/wombat/lib_bat.cr#L1" target="_blank">
<a href="https://github.com/kojix2/wombat/blob/8671b2fe37f333406cad773fe0d77fadb030da62/src/wombat/lib_bat.cr#L1" target="_blank">
wombat/lib_bat.cr
</a>

<br/>


<a href="https://github.com/kojix2/wombat/blob/92744c82f7327041bac83eb475010c8c51934f22/src/wombat/version.cr#L1" target="_blank">
<a href="https://github.com/kojix2/wombat/blob/8671b2fe37f333406cad773fe0d77fadb030da62/src/wombat/version.cr#L1" target="_blank">
wombat/version.cr
</a>

Expand Down Expand Up @@ -213,7 +213,7 @@ <h2>
<br/>
<div>

[<a href="https://github.com/kojix2/wombat/blob/92744c82f7327041bac83eb475010c8c51934f22/src/wombat.cr#L5" target="_blank">View source</a>]
[<a href="https://github.com/kojix2/wombat/blob/8671b2fe37f333406cad773fe0d77fadb030da62/src/wombat.cr#L5" target="_blank">View source</a>]

</div>
</div>
Expand All @@ -229,7 +229,7 @@ <h2>
<br/>
<div>

[<a href="https://github.com/kojix2/wombat/blob/92744c82f7327041bac83eb475010c8c51934f22/src/wombat.cr#L39" target="_blank">View source</a>]
[<a href="https://github.com/kojix2/wombat/blob/8671b2fe37f333406cad773fe0d77fadb030da62/src/wombat.cr#L39" target="_blank">View source</a>]

</div>
</div>
Expand All @@ -245,7 +245,7 @@ <h2>
<br/>
<div>

[<a href="https://github.com/kojix2/wombat/blob/92744c82f7327041bac83eb475010c8c51934f22/src/wombat.cr#L9" target="_blank">View source</a>]
[<a href="https://github.com/kojix2/wombat/blob/8671b2fe37f333406cad773fe0d77fadb030da62/src/wombat.cr#L9" target="_blank">View source</a>]

</div>
</div>
Expand All @@ -261,7 +261,7 @@ <h2>
<br/>
<div>

[<a href="https://github.com/kojix2/wombat/blob/92744c82f7327041bac83eb475010c8c51934f22/src/wombat.cr#L69" target="_blank">View source</a>]
[<a href="https://github.com/kojix2/wombat/blob/8671b2fe37f333406cad773fe0d77fadb030da62/src/wombat.cr#L69" target="_blank">View source</a>]

</div>
</div>
Expand Down
36 changes: 26 additions & 10 deletions index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,11 @@ <h1><a id="wombat" class="anchor" href="#wombat"> <svg class="octicon-link" ari
<use href="#octicon-link"/>
</svg>
</a>wombat</h1>
<p>Wombat is a Crystal binding for <a href="https://github.com/sharkdp/bat">bat</a> syntax highlighting library.</p>
<ul>
<li><a href="https://github.com/sharkdp/bat">bat</a> - A cat(1) clone with wings.</li>
<li><a href="https://github.com/kojix2/bat_c">bat_c</a> - A C wrapper for bat.</li>
</ul>
<h2><a id="installation" class="anchor" href="#installation">
<svg class="octicon-link" aria-hidden="true">
<use href="#octicon-link"/>
Expand All @@ -88,14 +93,27 @@ <h2><a id="installation" class="anchor" href="#installation">
<li>
<p>Run <code>shards install</code></p>
</li>
<li>
<p>Postinstall script will download the static library to `src/ext' directory.</p>
</li>
</ol>
<h2><a id="usage" class="anchor" href="#usage">
<svg class="octicon-link" aria-hidden="true">
<use href="#octicon-link"/>
</svg>
</a>Usage</h2>
<p>Download bat_c</p>
<pre><code class="language-crystal">crystal run scripts<span class="o">/</span>download_static_library.cr</code></pre>
<ul>
<li><a href="https://kojix2.github.io/wombat/">API Documentation</a></li>
</ul>
<h3><a id="example" class="anchor" href="#example">
<svg class="octicon-link" aria-hidden="true">
<use href="#octicon-link"/>
</svg>
</a>Example</h3>
<p>If you want to run the example, you need to download the static library first.</p>
<pre><code class="language-crystal">git clone https<span class="n">://</span>github.com<span class="o">/</span>kojix2<span class="o">/</span>wombat
shards install
crystal run scripts<span class="o">/</span>download_static_library.cr</code></pre>
<pre><code class="language-crystal"><span class="k">require</span> <span class="s">&quot;wombat&quot;</span>

puts <span class="t">Wombat</span>.pretty_string(<span class="s">%{puts &quot;hello world&quot;}</span>)</code></pre>
Expand All @@ -104,19 +122,17 @@ <h2><a id="development" class="anchor" href="#development">
<use href="#octicon-link"/>
</svg>
</a>Development</h2>
<p>Maintainability is important.</p>
<ul>
<li>Sustainable development is important.</li>
</ul>
<h2><a id="contributing" class="anchor" href="#contributing">
<svg class="octicon-link" aria-hidden="true">
<use href="#octicon-link"/>
</svg>
</a>Contributing</h2>
<ol>
<li>Fork it (<a href="https://github.com/your-github-user/bat/fork">https://github.com/your-github-user/bat/fork</a>)</li>
<li>Create your feature branch (<code>git checkout -b my-new-feature</code>)</li>
<li>Commit your changes (<code>git commit -am 'Add some feature'</code>)</li>
<li>Push to the branch (<code>git push origin my-new-feature</code>)</li>
<li>Create a new Pull Request</li>
</ol>
<ul>
<li>Your contributions are always welcome!</li>
</ul>
</div>
</body>
</html>
Loading

0 comments on commit 8629c75

Please sign in to comment.