From f038cac1945f85a03e314d2821674eca3250260e Mon Sep 17 00:00:00 2001 From: Erik Winter Date: Wed, 10 Mar 2021 06:50:49 +0100 Subject: [PATCH] links to new document --- README.md | 2 +- doc/a-tiny-subset-of-asciidoc-for-blogging.adoc | 2 ++ doc/why-i-built-my-own-shitty-static-site-generator.adoc | 2 +- 3 files changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 9308315..73a7881 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # My Shitty Static Site Generator -Although there are many SSG's out there that work perfectly fine, I still went through the effort of creating my own program to generate [my site](https://erikwinter.nl/). And after doing that I wrote a lot of text explaining why. As it turns out, there are some underlying motivations for creating your own tools that I think are interesting for non-programmers too. If you want to read more about it, check the [essay on my site](https://erikwinter.nl/articles/2020/why-i-built-my-own-shitty-static-site-generator/). There is also a [note on the markup used](https://erikwinter.nl/articles/2020/a-tiny-subset-of-asciidoc-for-blogging/). I will create some more documentation later. +Although there are many SSG's out there that work perfectly fine, I still went through the effort of creating my own program to generate [my site](https://erikwinter.nl/). And after doing that I wrote a lot of text explaining why. As it turns out, there are some underlying motivations for creating your own tools that I think are interesting for non-programmers too. If you want to read more about it, check the [essay on my site](https://erikwinter.nl/articles/2020/why-i-built-my-own-shitty-static-site-generator/). There is also a [note on the markup used](https://erikwinter.nl/articles/2020/a-tiny-subset-of-asciidoc-for-blogging/). I will create some more documentation later. [Here](https://erikwinter.nl/articles/2021/shitty-ssg-code-walkthrough/) is a high level description of the code. But, one of the points to do it was to have the freedom to put my content anywhere I want. So I was able to bundle everything together and you can find de source files out of which the mentioned posts are generated right in this repository, in de `doc` folder. diff --git a/doc/a-tiny-subset-of-asciidoc-for-blogging.adoc b/doc/a-tiny-subset-of-asciidoc-for-blogging.adoc index c518b5d..0a0d6b1 100644 --- a/doc/a-tiny-subset-of-asciidoc-for-blogging.adoc +++ b/doc/a-tiny-subset-of-asciidoc-for-blogging.adoc @@ -16,6 +16,8 @@ In order to achieve that, I selected the following parts from the Asciidoc speci Everything that is not described below will not work. I may add new stuff in the future, if I feel it is needed. If I do so, I will update this page. +The https://erikwinter.nl/articles/2021/shitty-ssg-code-walkthrough/[code walkthrough] of the SSG contains a short description of how the parser works. + == Header A header consists of the title of the post and various fields of metadata. It looks like this: diff --git a/doc/why-i-built-my-own-shitty-static-site-generator.adoc b/doc/why-i-built-my-own-shitty-static-site-generator.adoc index 824fb85..0808da3 100644 --- a/doc/why-i-built-my-own-shitty-static-site-generator.adoc +++ b/doc/why-i-built-my-own-shitty-static-site-generator.adoc @@ -81,4 +81,4 @@ So, my advise is to be aware of the restrictions and the hidden models of the to In the title, I mention that my generator is “shitty” and it is. It does not have many features. It is riddled with bugs and edge cases that it can’t handle. But that is not important. It works for my problem. If I don’t like something, I can fix it. If bug doesn’t bother me, I’ll let it be. Like all creative endevours, it is important to just start and get it out. You can always improve it later. -I put the source online https://git.sr.ht/~ewintr/shitty-ssg[here]. Not for people to blindly copy and run (why would you?), but to give some inspiration for people who are still on the fence. To show them that shitty does not have to be hard and that it can be good enough, as long as it is the right kind of shitty. _Your_ kind of shitty. +I put the source online https://git.sr.ht/~ewintr/shitty-ssg[here]. See https://erikwinter.nl/articles/2021/shitty-ssg-code-walkthrough/[here] for a high level overview. Not for people to blindly copy and run (why would you?), but to give some inspiration for people who are still on the fence. To show them that shitty does not have to be hard and that it can be good enough, as long as it is the right kind of shitty. _Your_ kind of shitty.