commit eed7a473d73c4c4e614c9692ef708ae6f222b8a4
parent 126ccb7c65708785c5747c0ca9ab0c8484c6e501
Author: St John Karp <contact@stjo.hn>
Date: Sat, 27 Jun 2020 14:16:56 -0500
Create an example folder and move html.pl
Created an example folder with a sample site.pl. Moved html.pl
into the example folder. Your template definition is part of your
site, not part of Squeeze, so you should be able to use the same
instance of Squeeze to generate sites with different templates.
Diffstat:
5 files changed, 67 insertions(+), 34 deletions(-)
diff --git a/README b/README
@@ -4,42 +4,59 @@ A static site generator that can put the toothpaste back in the tube.
## What is this?
-A few months ago I lost the source files I used to generate my static website. Fortunately there was no irreparable data loss because I still had the generated site up on my server. The problem was now I needed to write a script that would extract all the articles into source files again, and then I'd have to reconfigure the site generator. Then I went, "Oh. This is a Prolog problem." (But then I love Prolog so every problem is a Prolog problem. I don't care. Fight me.) A Prolog program is basically a set of rules and the logic that's guided by those rules can be run in either direction. I figured if I could write a Prolog program that described my HTML template then I could use the same code both to un-generate and re-generate the website.
-
-So the skinny is I wound up writing my own static website generator in Prolog. Well, the main components are in Prolog. I also wrote a shell script to make use of a bunch of common \*nix utilities (find, sed, grep, etc.) and to pipe output to some third-party programs where I needed them (Markdown and SmartyPants). Weirdest bit was that I just couldn't find anything decent to generate RSS feeds. I considered dropping the RSS all together, but I've spent enough time haranguing people for not supporting interoperable standards that I didn't want to be a hypocrite. I wound up writing my own RSS generator too, also in Prolog.
-
-It's pretty closely tailored to my specific needs, but it works, and IMHO it works better than my old site generator which injected a bunch of nonsense into my HTML. To make this work for your site, all you need to do is define the template of your website in "html.pl".
+A few months ago I lost the source files I used to generate my static website.
+Fortunately there was no irreparable data loss because I still had the
+generated site up on my server. The problem was now I needed to write a script
+that would extract all the articles into source files again, and then I'd have
+to reconfigure the site generator. Then I went, "Oh. This is a Prolog
+problem." (But then I love Prolog so every problem is a Prolog problem. I
+don't care. Fight me.) A Prolog program is basically a set of rules and the
+logic that's guided by those rules can be run in either direction. I figured
+if I could write a Prolog program that described my HTML template then I could
+use the same code both to un-generate and re-generate the website.
+
+So the skinny is I wound up writing my own static website generator in Prolog.
+Well, the main components are in Prolog. I also wrote a shell script to make
+use of a bunch of common \*nix utilities (find, sed, grep, etc.) and to pipe
+output to some third-party programs where I needed them (Markdown and
+SmartyPants). Weirdest bit was that I just couldn't find anything decent to
+generate RSS feeds. I considered dropping the RSS all together, but I've spent
+enough time haranguing people for not supporting interoperable standards that
+I didn't want to be a hypocrite. I wound up writing my own RSS generator too,
+also in Prolog.
+
+It's pretty closely tailored to my specific needs, but it works, and IMHO it
+works better than my old site generator which injected a bunch of nonsense
+into my HTML. To make this work for your site, all you need to do is set some
+config values in `site.pl` and define your template in `html.pl`.
## Dependencies
* A POSIX shell. Used to run the script that automates everything else.
-* A Prolog interpreter. Tested with [SWI-Prolog](https://www.swi-prolog.org/) and [GNU Prolog](http://www.ohloh.net/p/gprolog), but the syntax aims to be vanilla ISO Prolog and should work with any implementation.
-* [Markdown](https://daringfireball.net/projects/markdown/). Used to convert Markdown to HTML.
-* [SmartyPants](https://daringfireball.net/projects/smartypants/). Used to smarten the punctuation in the HTML output.
+* A Prolog interpreter. Tested with [SWI-Prolog](https://www.swi-prolog.org/)
+ and [GNU Prolog](http://www.ohloh.net/p/gprolog), but the syntax aims to be
+ vanilla ISO Prolog and should work with any implementation.
+* [Markdown](https://daringfireball.net/projects/markdown/). Used to convert
+ Markdown to HTML.
+* [SmartyPants](https://daringfireball.net/projects/smartypants/). Used to
+ smarten the punctuation in the HTML output.
## Assumptions
-The website folder used in the second argument is expected to contain three things:
-
-* a "source" folder containing the website's source;
-* an "output" folder containing the website's static output;
-* and a "site.pl" file containing site-specific definitions.
-
-One or the other of the "source" and "output" folders must be populated, but not necessarily both. In the case of saving a website for which you'd lost the source code, you'd populate "output", ungenerate the site, then commit the contents of "source" to version control.
-
-site.pl contains DCG definitions of this site's specifics, such as title, author, etc. An example site.pl file might look like this:
-
- site_title --> "My website name".
-
- site_subtitle --> "My website description/subtitle".
-
- site_url --> "https://www.example.com".
+Your website folder is expected to contain four things:
- user_email --> "webmaster@example.com".
+* a `source` folder containing the website's source files;
+* an `output` folder containing the website's static output;
+* a `site.pl` file containing site-specific definitions;
+* an `html.pl` file containing your site template.
- user_name --> "Harold Gruntfuttock".
+One or the other of the `source` and `output` folders must be populated, but
+not necessarily both. In the case of saving a website for which you've lost
+the source code, you'd populate `output`, ungenerate the site, then commit the
+contents of `source` to version control.
- markdown_command(['/usr/bin/hoedown', '--footnotes']).
+An example `site.pl` and `html.pl` are included in the `example` folder of
+this repo.
## Use
@@ -53,6 +70,11 @@ Generate source files from a static website:
## Notes
-The Markdown converter is called from inside Prolog, so the path to your Markdown (and any arguments) is specified in site.pl. This allows you to have different Markdown converters or arguments on a per-site basis.
+The Markdown converter is called from inside Prolog, so the path to your
+Markdown (and any arguments) is specified in `site.pl`. This allows you to
+have different Markdown converters or arguments on a per-site basis.
-Because ISO Prolog doesn't support making calls to external programs, I've implemented a compatibility layer that allows you to define the `markdown_to_html` predicate for whatever dialect of Prolog you happen to use. Included are compatibility predicates for SWI-Prolog and GNU Prolog.
+Because ISO Prolog doesn't support making calls to external programs, I've
+implemented a compatibility layer that allows you to define the
+`markdown_to_html` predicate for whatever dialect of Prolog you happen to use.
+Included are compatibility predicates for SWI-Prolog and GNU Prolog.
diff --git a/html.pl b/example/html.pl
diff --git a/example/site.pl b/example/site.pl
@@ -0,0 +1,15 @@
+% Site settings.
+
+:- include('html.pl').
+
+site_title --> "My website name".
+
+site_subtitle --> "My website description/subtitle".
+
+site_url --> "https://www.example.com".
+
+user_email --> "webmaster@example.com".
+
+user_name --> "Harold Gruntfuttock".
+
+markdown_command(['/usr/bin/hoedown', '--footnotes']).
diff --git a/generate_rss.pl b/generate_rss.pl
@@ -4,7 +4,6 @@
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
:- include('helpers.pl').
-:- include('html.pl').
:- include('rss.pl').
% generate_rss(+BuildDate, +Filenames).
@@ -62,4 +61,4 @@ get_link(Filename, Link):-
append_lists(StartPath, Path, FilenameCodes),
append_lists(PathWithoutExtension, ".html", Path),
append_lists(PathWithoutExtension, "/", PathWithSlash),
- append_lists(URL, PathWithSlash, Link).
-\ No newline at end of file
+ append_lists(URL, PathWithSlash, Link).
diff --git a/parse_entry.pl b/parse_entry.pl
@@ -4,7 +4,6 @@
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
:- include('helpers.pl').
-:- include('html.pl').
:- include('markdown.pl').
% Include files for dialect-dependent predicates.
@@ -58,4 +57,4 @@ generate_html(Markdown):-
markdown_to_html(EntryCodes, HTMLEntryCodes),
page(HTMLEntryCodes, Title, Subtitle, Date, HTMLCodes, []),
write_codes(user_output, HTMLCodes),
- halt.
-\ No newline at end of file
+ halt.
