diff --git a/command_reference.html b/command_reference.html index f27a1f4..35fc30a 100644 --- a/command_reference.html +++ b/command_reference.html @@ -1279,26 +1279,20 @@
Contents: - +
-
-

Djot command reference

+

Djot command reference

Back to main page

-

Installation

cargo install simple-ssg
-
-

Building Locally

git clone https://github.com/ryanabx/simple-ssg
 cd simple-ssg
 cargo build --release
-
-

Usage

Plain and simple static site generator for Djot and Markdown light markup languages
 
@@ -1316,15 +1310,11 @@ 
Usage

   -h, --help                     Print help
   -V, --version                  Print version
-
-

Debugging

-

TIP: Use the RUST_LOG environment variable to change the log level of the application:
+

TIP: Use the RUST_LOG environment variable to change the log level of the application:
i.e. RUST_LOG=trace simple-ssg ...

-
-
diff --git a/index.html b/index.html index cbf2cdb..55e0921 100644 --- a/index.html +++ b/index.html @@ -1279,46 +1279,30 @@
Contents: - +
-
-

SMPL Static Site Generator

+

SMPL Static Site Generator

https://github.com/ryanabx/simple-ssg

Command Reference

-

A simple static site generator for Djot/Markdown!

-

What is Djot?

Djot is a light markup language created by John MacFarlane, who was consequential in developing CommonMark, which is a standardized variant of Markdown.

-
-

Why Djot and not Markdown?

-

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 Jotdown. 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.

-

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 https://johnmacfarlane.net/beyond-markdown.html.

-
-
+

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 Jotdown. 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.

+

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 https://johnmacfarlane.net/beyond-markdown.html.

Why make a static site generator?

-

Honestly, I was just wanting a bit more tooling for Djot. I created a Visual studio code plugin, 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.

+

Honestly, I was just wanting a bit more tooling for Djot. I created a Visual studio code plugin, 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.

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!

    -
  • -A warning if index.dj || index.djot doesn’t exist. Most sites will use index.html as the entry point to a site -
    • -
  • -A warning if a local link is broken -
    • -
  • -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) -
    • +
  • A warning if index.dj || index.djot doesn't exist. Most sites will use index.html as the entry point to a site
    • +
  • A warning if a local link is broken
    • +
  • 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)
-

You can also use the --no-warn argument to turn warnings into errors, if you value having an absolutely “correct” website generated!

+

You can also use the --no-warn argument to turn warnings into errors, if you value having an absolutely "correct" website generated!

See more from me at https://github.com/ryanabx

-

ryanabx profile photo

-
-
-
+

ryanabx profile photo

diff --git a/notes/contact-ryanabx.html b/notes/contact-ryanabx.html index e7014ab..0af0696 100644 --- a/notes/contact-ryanabx.html +++ b/notes/contact-ryanabx.html @@ -1279,22 +1279,16 @@
Contents: - +

Back to home page

-

Contact Ryanabx

-
diff --git a/notes/djot-example.html b/notes/djot-example.html index b6bd3de..6252ba8 100644 --- a/notes/djot-example.html +++ b/notes/djot-example.html @@ -1279,17 +1279,15 @@
Contents: - +
-
-

Djot example

-
+

Djot example

+

This is a simple djot example to showcase this static site generator! It gets put into the template called template.html 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 :)

-
-

For more, see the Markdown example and go to the command reference at ../command_reference.dj

-
+
+

For more, see the Markdown example and go to the command reference at ../command_reference.md

diff --git a/notes/markdown-example.html b/notes/markdown-example.html index 40874c3..dfe9577 100644 --- a/notes/markdown-example.html +++ b/notes/markdown-example.html @@ -1279,13 +1279,13 @@
Contents: - +

Markdown example

This static site generator also supports Markdown, using pulldown-cmark!

-

This provides an example of using markdown alongside djot documents in the same static site! See: ../index.dj for the home page, and ../command_reference for the command reference!

+

This provides an example of using markdown alongside djot documents in the same static site! See: ../index.md for the home page, and ../command_reference for the command reference!

Contact me here

diff --git a/templating.html b/templating.html index 5955a64..57083d2 100644 --- a/templating.html +++ b/templating.html @@ -1279,7 +1279,7 @@
Contents: - +