Skip to content

Commit

Permalink
build docs
Browse files Browse the repository at this point in the history
Signed-off-by: Alex Suraci <suraci.alex@gmail.com>
  • Loading branch information
vito committed Feb 7, 2021
1 parent 45ec11e commit 286815a
Show file tree
Hide file tree
Showing 7 changed files with 20 additions and 20 deletions.
6 changes: 3 additions & 3 deletions docs/baselit.html
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@

<li><a href="html-renderer.html">HTML Renderer</a></li>

<li><a href="plugins.html">Plugin System</a></li>
<li><a href="plugins.html">Plugins</a></li>

<li><a href="booklit-syntax.html">Syntax</a></li>

Expand Down Expand Up @@ -149,7 +149,7 @@ <h2 class="section-header"><a id="customizing-sections"></a><span class="section
<pre class="definition-thumb"><a id="use-plugin"></a><code class="highlight"><span style="color:#ed6c30;font-weight:bold">\<a href="baselit.html#use-plugin">use-plugin</a></span>{<em>name</em>}</code></pre>

<div class="definition-content">
<p>Register the plugin identified by <em>name</em> in the section. The plugin must be specified by <code>--plugin</code> on the command-line. See <a href="plugins.html">Plugin System</a> for more information.</p>
<p>Register the plugin identified by <em>name</em> in the section. The plugin must be specified by <code>--plugin</code> on the command-line. See <a href="plugins.html">Plugins</a> for more information.</p>
</div>
</div><div class="definition">
<pre class="definition-thumb"><a id="styled"></a><code class="highlight"><span style="color:#ed6c30;font-weight:bold">\<a href="baselit.html#styled">styled</a></span>{<em>name</em>}</code></pre>
Expand All @@ -161,7 +161,7 @@ <h2 class="section-header"><a id="customizing-sections"></a><span class="section
<pre class="definition-thumb"><a id="set-partial"></a><code class="highlight"><span style="color:#ed6c30;font-weight:bold">\<a href="baselit.html#set-partial">set-partial</a></span>{<em>name</em>}{<em>content</em>}</code></pre>

<div class="definition-content">
<p>Define the partial <em>name</em> in the section with <em>content</em> as its content.</p><p>This is useful for communicating content to either <a href="plugins.html">Plugin System</a> or custom templates given to the <a href="html-renderer.html">HTML renderer</a>.</p>
<p>Define the partial <em>name</em> in the section with <em>content</em> as its content.</p><p>This is useful for communicating content to either <a href="plugins.html">Plugins</a> or custom templates given to the <a href="html-renderer.html">HTML renderer</a>.</p>
</div>
</div>

Expand Down
2 changes: 1 addition & 1 deletion docs/booklit-syntax.html
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@

<li><a href="html-renderer.html">HTML Renderer</a></li>

<li><a href="plugins.html">Plugin System</a></li>
<li><a href="plugins.html">Plugins</a></li>

<li class="current"><a href="booklit-syntax.html">Syntax</a></li>

Expand Down
4 changes: 2 additions & 2 deletions docs/getting-started.html
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@

<li><a href="html-renderer.html">HTML Renderer</a></li>

<li><a href="plugins.html">Plugin System</a></li>
<li><a href="plugins.html">Plugins</a></li>

<li><a href="booklit-syntax.html">Syntax</a></li>

Expand Down Expand Up @@ -181,7 +181,7 @@ <h2 class="section-header"><a id="next-steps"></a><span class="section-number"><

<li><p>To learn the <code class="highlight"><span style="color:#ed6c30;font-weight:bold">\functions</span></code> that come with Booklit, check out <a href="baselit.html">Basic Functions</a>.</p></li>

<li><p>To extend your documents with your own <code class="highlight"><span style="color:#ed6c30;font-weight:bold">\functions</span></code>, check out <a href="plugins.html">Plugin System</a>.</p></li>
<li><p>To extend your documents with your own <code class="highlight"><span style="color:#ed6c30;font-weight:bold">\functions</span></code>, check out <a href="plugins.html">Plugins</a>.</p></li>

</ul>

Expand Down
2 changes: 1 addition & 1 deletion docs/html-renderer.html
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@

<li class="current"><a href="html-renderer.html">HTML Renderer</a></li>

<li><a href="plugins.html">Plugin System</a></li>
<li><a href="plugins.html">Plugins</a></li>

<li><a href="booklit-syntax.html">Syntax</a></li>

Expand Down
18 changes: 9 additions & 9 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@

<li><a href="html-renderer.html">HTML Renderer</a></li>

<li><a href="plugins.html">Plugin System</a></li>
<li><a href="plugins.html">Plugins</a></li>

<li><a href="booklit-syntax.html">Syntax</a></li>

Expand All @@ -33,25 +33,26 @@
</ul>
</nav>

<p>Booklit is a tool for building static websites from semantic documents.</p><p>Booklit enforces a tidy separation between <strong>content</strong>, <strong>logic</strong>, and <strong>presentation</strong> that makes it well-suited for writing and refactoring websites of any size and complexity.</p><div class="columns">
<span style="font-size: 120%"><p>Booklit is a tool for building static websites from semantic documents.</p></span><p>Booklit enforces a tidy separation between <strong>content</strong>, <strong>logic</strong>, and <strong>presentation</strong> that makes it easy to write and refactor websites for anything from technical documentation to slide decks to blogs.</p><div class="columns">
<div class="column title"><div class="column-header">content in <code>*.lit</code></div><p>Booklit documents are text files which evaluate <code class="highlight"><span style="color:#ed6c30;font-weight:bold">\functions</span></code> to generate content, ultimately resulting in a tree of sections.</p><p>Sections are easy to move around, allowing you to continuously refactor and restructure your content without having to tweak header sizes and update internal links.</p></div>

<div class="column"><div class="lit-syntax"><div class="highlight"><pre style=""><span style="color:#ed6c30;font-weight:bold">\<a href="baselit.html#title">title</a></span>{Hello}
<div class="column"><div class="lit-syntax"><div class="highlight"><pre style=""><span style="color:#ed6c30;font-weight:bold">\<a href="baselit.html#title">title</a></span>{Hello}{index}

Hello, world! I&#39;m a Booklit document.

Check out my favorite <span style="color:#ed6c30;font-weight:bold">\<a href="baselit.html#reference">reference</a></span>{quotes}!

<span style="color:#ed6c30;font-weight:bold">\<a href="baselit.html#include-section">include-section</a></span>{quotes.lit}
</pre></div></div><div class="lit-syntax"><div class="highlight"><pre style=""><span style="color:#ed6c30;font-weight:bold">\<a href="baselit.html#title">title</a></span>{Quotes}

<span style="color:#ed6c30;font-weight:bold">\<a href="baselit.html#use-plugin">use-plugin</a></span>{example}

<span style="color:#ed6c30;font-weight:bold">\quote</span>{
It&#39;s <span style="color:#ed6c30;font-weight:bold">\<a href="baselit.html#bold">bold</a></span>{lit}!
It&#39;s lit!
}{Travis Scott}
</pre></div></div></div>

</div><div class="columns">
<div class="column title"><div class="column-header">logic in <code>*.go</code></div><p>Logic is implemented by <code class="highlight"><span style="color:#ed6c30;font-weight:bold">\functions</span></code> which are provided by plugins written <a href="https://golang.org">Go</a>. Go is a simple language with <a href="https://pkg.go.dev/">plenty of libraries</a> around if you need them.</p><p>Plugins allow your content to be semantic - saying what it means, decoupled from how it should be computed or displayed.</p></div>
<div class="column title"><div class="column-header">logic in <code>*.go</code></div><p>Sections use plugins to invoke <code class="highlight"><span style="color:#ed6c30;font-weight:bold">\functions</span></code> written <a href="https://golang.org">Go</a>. Go is a simple and fast language with <a href="https://pkg.go.dev/">plenty of packages</a> around if you need them.</p><p>Plugins allow your content to be semantic - saying what it means, decoupled from how it should be computed or displayed.</p></div>

<div class="column"><div class="highlight"><pre style=""><span style="color:#ed6c30;font-weight:bold">func</span> (Example) Quote(
quote, source booklit.Content,
Expand Down Expand Up @@ -91,8 +92,7 @@
<div class="column title"><div class="column-header">build with <code>booklit</code></div><p>The <code>booklit</code> CLI is a single command which loads Booklit documents and renders them.</p><p>When an error occurs, Booklit will show the location of the error and try to suggest a fix.</p></div>

<div class="column"><pre>$ booklit -i ./index.lit -o ./public/
<span class="syntax-hl">INFO</span>[0000] rendering
$ booklit -i ./to-err-is-human.lit
<span class="syntax-hl">INFO</span>[0000] rendering</pre><pre>$ booklit -i ./to-err-is-human.lit
to-err-is-human.lit:5: unknown tag &#39;helo&#39;

5| Say \reference{helo}!
Expand All @@ -104,7 +104,7 @@
Did you mean one of these?</pre></div>

</div><div class="columns">
<div class="column title"><div class="column-header">run with <code>booklit -s $PORT</code></div><p>In server mode, Booklit renders content on each request with only plugin changes requiring a server restart.</p><p>The feedback loop is <em>wicked fast</em>.</p></div>
<div class="column title"><div class="column-header">serve with <code>booklit -s $PORT</code></div><p>In server mode, Booklit renders content on each request with only plugin changes requiring a server restart.</p><p>The feedback loop is <em>wicked fast</em>.</p></div>

<div class="column"><pre>$ booklit -i ./index.lit -s 3000
<span class="syntax-hl">INFO</span>[0000] listening</pre><p><iframe class="output-frame" scrolling="no" src="outputs/index.html"></iframe></p></div>
Expand Down
6 changes: 3 additions & 3 deletions docs/plugins.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<meta name="viewport" content="width=device-width" />
<title>Plugin System</title>
<title>Plugins</title>
<link rel="stylesheet" type="text/css" href="css/iosevka.css" />
<link rel="stylesheet" type="text/css" href="css/booklit.css" />
<link rel="shortcut icon" type="image/x-icon" href="favicon.ico" />
Expand All @@ -24,7 +24,7 @@

<li><a href="html-renderer.html">HTML Renderer</a></li>

<li class="current"><a href="plugins.html">Plugin System</a></li>
<li class="current"><a href="plugins.html">Plugins</a></li>

<li><a href="booklit-syntax.html">Syntax</a></li>

Expand All @@ -33,7 +33,7 @@
</ul>
</nav>

<h1 class="section-header"><a id="plugins"></a><span class="section-number"><a href="plugins.html">4</a> </span>Plugin System</h1>
<h1 class="section-header"><a id="plugins"></a><span class="section-number"><a href="plugins.html">4</a> </span>Plugins</h1>

<p>Plugins provide the functionality behind function calls like <code class="highlight"><span style="color:#ed6c30;font-weight:bold">\foo</span>{bar}</code>.</p><p>Out of the box, Booklit comes with a plugin called <a href="baselit.html"><code>baselit</code></a> which provides basic functions like <a href="baselit.html#title"><code class="highlight"><span style="color:#ed6c30;font-weight:bold">\title</span></code></a>, <a href="baselit.html#section"><code class="highlight"><span style="color:#ed6c30;font-weight:bold">\section</span></code></a>, <a href="baselit.html#italic"><code class="highlight"><span style="color:#ed6c30;font-weight:bold">\italic</span></code></a>, and <a href="baselit.html#bold"><code class="highlight"><span style="color:#ed6c30;font-weight:bold">\bold</span></code></a>.</p><p>More functions can be added by writing plugins and using them in your documents.</p><p>If you&#39;ve skipped ahead, you may want to check out <a href="getting-started.html">Getting Started</a> to see how to set up your Go module.</p>
<nav>
Expand Down
2 changes: 1 addition & 1 deletion docs/thanks.html
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@

<li><a href="html-renderer.html">HTML Renderer</a></li>

<li><a href="plugins.html">Plugin System</a></li>
<li><a href="plugins.html">Plugins</a></li>

<li><a href="booklit-syntax.html">Syntax</a></li>

Expand Down

0 comments on commit 286815a

Please sign in to comment.