Skip to content

Commit

Permalink
deploy: e1dbbd1
Browse files Browse the repository at this point in the history
  • Loading branch information
@ryanabx
ryanabx committed Dec 13, 2024
1 parent 1488077 commit a607edb
Show file tree
Hide file tree
Showing 6 changed files with 24 additions and 58 deletions.
16 changes: 3 additions & 13 deletions command_reference.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1279,26 +1279,20 @@
<div class="my-container">
<div class="table-of-contents">
Contents:
<ul><li><b><u>notes:</u></b></li><ul><li><a href="notes/contact-ryanabx.html">contact-ryanabx</a></li><li><a href="notes/djot-example.html">djot-example</a></li><li><a href="notes/markdown-example.html">markdown-example</a></li></ul><li><a href="index.html">index</a></li><li><b>command_reference</b></li><li><a href="templating.html">templating</a></li></ul>
<ul><li><a href="templating.html">templating</a></li><li><b><u>notes:</u></b></li><ul><li><a href="notes/markdown-example.html">markdown-example</a></li><li><a href="notes/contact-ryanabx.html">contact-ryanabx</a></li><li><a href="notes/djot-example.html">djot-example</a></li></ul><li><b>command_reference</b></li><li><a href="index.html">index</a></li></ul>
</div>
<div class="content-border">
<div class="content-body">
<section id="Djot-command-reference">
<h1>Djot command reference</h1>
<h1>Djot command reference</h1>
<p><a href="./index.html">Back to main page</a></p>
<section id="Installation">
<h2>Installation</h2>
<pre><code class="language-shell">cargo install simple-ssg
</code></pre>
</section>
<section id="Building-Locally">
<h2>Building Locally</h2>
<pre><code class="language-shell">git clone https://github.com/ryanabx/simple-ssg
cd simple-ssg
cargo build --release
</code></pre>
</section>
<section id="Usage">
<h2>Usage</h2>
<pre><code class="language-shell">Plain and simple static site generator for Djot and Markdown light markup languages

Expand All @@ -1316,15 +1310,11 @@ <h2>Usage</h2>
-h, --help Print help
-V, --version Print version
</code></pre>
</section>
<section id="Debugging">
<h2>Debugging</h2>
<blockquote>
<p><strong>TIP:</strong> Use the <code>RUST_LOG</code> environment variable to change the log level of the application: <br>
<p><em>TIP:</em> Use the <code>RUST_LOG</code> environment variable to change the log level of the application: <br />
i.e. <code>RUST_LOG=trace simple-ssg ...</code></p>
</blockquote>
</section>
</section>

</div>
</div>
Expand Down
36 changes: 10 additions & 26 deletions index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1279,46 +1279,30 @@
<div class="my-container">
<div class="table-of-contents">
Contents:
<ul><li><b><u>notes:</u></b></li><ul><li><a href="notes/contact-ryanabx.html">contact-ryanabx</a></li><li><a href="notes/djot-example.html">djot-example</a></li><li><a href="notes/markdown-example.html">markdown-example</a></li></ul><li><b>index</b></li><li><a href="command_reference.html">command_reference</a></li><li><a href="templating.html">templating</a></li></ul>
<ul><li><a href="templating.html">templating</a></li><li><b><u>notes:</u></b></li><ul><li><a href="notes/markdown-example.html">markdown-example</a></li><li><a href="notes/contact-ryanabx.html">contact-ryanabx</a></li><li><a href="notes/djot-example.html">djot-example</a></li></ul><li><a href="command_reference.html">command_reference</a></li><li><b>index</b></li></ul>
</div>
<div class="content-border">
<div class="content-body">
<section id="SMPL-Static-Site-Generator">
<h1>SMPL Static Site Generator</h1>
<h1>SMPL Static Site Generator</h1>
<p><a href="https://github.com/ryanabx/simple-ssg">https://github.com/ryanabx/simple-ssg</a></p>
<p><a href="./command_reference">Command Reference</a></p>
<section id="A-simple-static-site-generator-for-DjotMarkdown">
<h2>A simple static site generator for Djot/Markdown!</h2>
<section id="What-is-Djot">
<h3>What is Djot?</h3>
<p><a href="https://github.com/jgm/djot">Djot</a> is a light markup language created by <a href="https://github.com/jgm">John MacFarlane</a>, who was consequential in developing <a href="https://commonmark.org/">CommonMark</a>, which is a standardized variant of Markdown.</p>
</section>
<section id="Why-Djot-and-not-Markdown">
<h3>Why Djot and not Markdown?</h3>
<p>I decided to make this simple generator because the tooling for Djot is actually quite nice. The reference parser is written in TypeScript, but there is a parser written in rust which I’m using for this project called <a href="https://github.com/hellux/jotdown">Jotdown</a>. One of Djot’s goals is to have single-pass parsing, and the rules are much simpler than Markdown, leaving less up to interpretation. This makes writing a parser for Djot very simple compared to having to interpret edge cases in Markdown.</p>
<p>The syntax of Djot is very similar to Markdown, but it removes some of the inconsistencies that couldn’t be removed in CommonMark. John MacFarlane has a great blog post with some of the ideas that made it into Djot, see <a href="https://johnmacfarlane.net/beyond-markdown.html">https://johnmacfarlane.net/beyond-markdown.html</a>.</p>
</section>
<section id="Why-make-a-static-site-generator">
<p>I decided to make this simple generator because the tooling for Djot is actually quite nice. The reference parser is written in TypeScript, but there is a parser written in rust which I'm using for this project called <a href="https://github.com/hellux/jotdown">Jotdown</a>. One of Djot's goals is to have single-pass parsing, and the rules are much simpler than Markdown, leaving less up to interpretation. This makes writing a parser for Djot very simple compared to having to interpret edge cases in Markdown.</p>
<p>The syntax of Djot is very similar to Markdown, but it removes some of the inconsistencies that couldn't be removed in CommonMark. John MacFarlane has a great blog post with some of the ideas that made it into Djot, see <a href="https://johnmacfarlane.net/beyond-markdown.html">https://johnmacfarlane.net/beyond-markdown.html</a>.</p>
<h3>Why make a static site generator?</h3>
<p>Honestly, I was just wanting a bit more tooling for Djot. I created a <a href="https://github.com/ryanabx/djot-vscode">Visual studio code plugin</a>, and decided I wanted to have more fun with Djot. Since I build projects in rust, I’m thankful that Jotdown exists to take care of the parsing part for me, all I had to do was handle the conversions.</p>
<p>Honestly, I was just wanting a bit more tooling for Djot. I created a <a href="https://github.com/ryanabx/djot-vscode">Visual studio code plugin</a>, and decided I wanted to have more fun with Djot. Since I build projects in rust, I'm thankful that Jotdown exists to take care of the parsing part for me, all I had to do was handle the conversions.</p>
<p>The scope of this generator is pretty simple, no table of contents, no sidebar, just raw Djot parsing. There are some nice warnings that the generator will let you know about though!</p>
<ul>
<li>
A warning if <code>index.dj || index.djot</code> doesn’t exist. Most sites will use <code>index.html</code> as the entry point to a site
</li>
<li>
A warning if a local link is broken
</li>
<li>
A warning if a path in the directory walk is not relative to the target directory (this should pretty much never happen, but it’s there just in case)
</li>
<li>A warning if <code>index.dj || index.djot</code> doesn't exist. Most sites will use <code>index.html</code> as the entry point to a site</li>
<li>A warning if a local link is broken</li>
<li>A warning if a path in the directory walk is not relative to the target directory (this should pretty much never happen, but it's there just in case)</li>
</ul>
<p>You can also use the <code>--no-warn</code> argument to turn warnings into errors, if you value having an absolutely “correct” website generated!</p>
<p>You can also use the <code>--no-warn</code> argument to turn warnings into errors, if you value having an absolutely "correct" website generated!</p>
<p>See more from me at <a href="https://github.com/ryanabx">https://github.com/ryanabx</a></p>
<p><img alt="ryanabx profile photo" src="https://avatars.githubusercontent.com/u/56272643?v=4"></p>
</section>
</section>
</section>
<p><img src="https://avatars.githubusercontent.com/u/56272643?v=4" alt="ryanabx profile photo" /></p>

</div>
</div>
Expand Down
12 changes: 3 additions & 9 deletions notes/contact-ryanabx.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1279,22 +1279,16 @@
<div class="my-container">
<div class="table-of-contents">
Contents:
<ul><li><b><u>notes:</u></b></li><ul><li><b>contact-ryanabx</b></li><li><a href="../notes/djot-example.html">djot-example</a></li><li><a href="../notes/markdown-example.html">markdown-example</a></li></ul><li><a href="../index.html">index</a></li><li><a href="../command_reference.html">command_reference</a></li><li><a href="../templating.html">templating</a></li></ul>
<ul><li><a href="../templating.html">templating</a></li><li><b><u>notes:</u></b></li><ul><li><a href="../notes/markdown-example.html">markdown-example</a></li><li><b>contact-ryanabx</b></li><li><a href="../notes/djot-example.html">djot-example</a></li></ul><li><a href="../command_reference.html">command_reference</a></li><li><a href="../index.html">index</a></li></ul>
</div>
<div class="content-border">
<div class="content-body">
<p><a href="../index.html">Back to home page</a></p>
<section id="Contact-Ryanabx">
<h1>Contact Ryanabx</h1>
<ul>
<li>
<a href="https://mastodon.social/@ryanabx">Mastodon</a>
</li>
<li>
<a href="https://github.com/ryanabx">GitHub</a>
</li>
<li><a href="https://mastodon.social/@ryanabx">Mastodon</a></li>
<li><a href="https://github.com/ryanabx">GitHub</a></li>
</ul>
</section>

</div>
</div>
Expand Down
12 changes: 5 additions & 7 deletions notes/djot-example.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1279,17 +1279,15 @@
<div class="my-container">
<div class="table-of-contents">
Contents:
<ul><li><b><u>notes:</u></b></li><ul><li><a href="../notes/contact-ryanabx.html">contact-ryanabx</a></li><li><b>djot-example</b></li><li><a href="../notes/markdown-example.html">markdown-example</a></li></ul><li><a href="../index.html">index</a></li><li><a href="../command_reference.html">command_reference</a></li><li><a href="../templating.html">templating</a></li></ul>
<ul><li><a href="../templating.html">templating</a></li><li><b><u>notes:</u></b></li><ul><li><a href="../notes/markdown-example.html">markdown-example</a></li><li><a href="../notes/contact-ryanabx.html">contact-ryanabx</a></li><li><b>djot-example</b></li></ul><li><a href="../command_reference.html">command_reference</a></li><li><a href="../index.html">index</a></li></ul>
</div>
<div class="content-border">
<div class="content-body">
<section id="Djot-example">
<h1>Djot example</h1>
<hr>
<h1>Djot example</h1>
<hr />
<p>This is a simple djot example to showcase this static site generator! It gets put into the template called <code>template.html</code> in the home directory of this documentation, and as a result it has some nice formatting and a simple table of contents! The template is of course not required though :)</p>
<hr>
<p>For more, see the <a href="./markdown-example.html">Markdown example</a> and go to the command reference at <a href="../command_reference.html">../command_reference.dj</a></p>
</section>
<hr />
<p>For more, see the <a href="./markdown-example.html">Markdown example</a> and go to the command reference at <a href="../command_reference.html">../command_reference.md</a></p>

</div>
</div>
Expand Down
4 changes: 2 additions & 2 deletions notes/markdown-example.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1279,13 +1279,13 @@
<div class="my-container">
<div class="table-of-contents">
Contents:
<ul><li><b><u>notes:</u></b></li><ul><li><a href="../notes/contact-ryanabx.html">contact-ryanabx</a></li><li><a href="../notes/djot-example.html">djot-example</a></li><li><b>markdown-example</b></li></ul><li><a href="../index.html">index</a></li><li><a href="../command_reference.html">command_reference</a></li><li><a href="../templating.html">templating</a></li></ul>
<ul><li><a href="../templating.html">templating</a></li><li><b><u>notes:</u></b></li><ul><li><b>markdown-example</b></li><li><a href="../notes/contact-ryanabx.html">contact-ryanabx</a></li><li><a href="../notes/djot-example.html">djot-example</a></li></ul><li><a href="../command_reference.html">command_reference</a></li><li><a href="../index.html">index</a></li></ul>
</div>
<div class="content-border">
<div class="content-body">
<h1>Markdown example</h1>
<p>This static site generator also supports Markdown, using <a href="https://github.com/pulldown-cmark/pulldown-cmark">pulldown-cmark</a>!</p>
<p>This provides an example of using markdown alongside djot documents in the same static site! See: <a href="../index.html">../index.dj</a> for the home page, and <a href="../command_reference.html">../command_reference</a> for the command reference!</p>
<p>This provides an example of using markdown alongside djot documents in the same static site! See: <a href="../index.html">../index.md</a> for the home page, and <a href="../command_reference.html">../command_reference</a> for the command reference!</p>
<p>Contact me <a href="contact-ryanabx.html">here</a></p>

</div>
Expand Down
2 changes: 1 addition & 1 deletion templating.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1279,7 +1279,7 @@
<div class="my-container">
<div class="table-of-contents">
Contents:
<ul><li><b><u>notes:</u></b></li><ul><li><a href="notes/contact-ryanabx.html">contact-ryanabx</a></li><li><a href="notes/djot-example.html">djot-example</a></li><li><a href="notes/markdown-example.html">markdown-example</a></li></ul><li><a href="index.html">index</a></li><li><a href="command_reference.html">command_reference</a></li><li><b>templating</b></li></ul>
<ul><li><b>templating</b></li><li><b><u>notes:</u></b></li><ul><li><a href="notes/markdown-example.html">markdown-example</a></li><li><a href="notes/contact-ryanabx.html">contact-ryanabx</a></li><li><a href="notes/djot-example.html">djot-example</a></li></ul><li><a href="command_reference.html">command_reference</a></li><li><a href="index.html">index</a></li></ul>
</div>
<div class="content-border">
<div class="content-body">
Expand Down

0 comments on commit a607edb

Please sign in to comment.