From 29a5bd0ec24b21948eb05cb927a50ec44c64a7e1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Hugo=20H=C3=B6rnquist?= <hugo@lysator.liu.se> Date: Wed, 8 Feb 2023 23:05:14 +0100 Subject: [PATCH] Rewrote README. --- README.md | 33 +++------------------------------ 1 file changed, 3 insertions(+), 30 deletions(-) diff --git a/README.md b/README.md index db54bb2..bba3f9e 100644 --- a/README.md +++ b/README.md @@ -1,31 +1,4 @@ -### Module directory layout -#### content-type -Contains content type parsers for different formats. For example -`(content-type text html)` is for `text/html`. Required to provide -the procedure `body->html`, which takes a source string and returns -an HTML string +SSG - A Static Site Generator +============================= -#### Widgets - - -### User Directory layout -- **config** -- **entries/** - Feed entries -- **module/** - Extra scheme code, mainly for custom widgets (and content types) -- **pages/** - Backbone of webpage - All static pages are declared here, along with the directory layout -- **static/** - Will be copyied verbatim into /static of the output -- **template/** - Template files for pages in `pages` - - -### Entry fields -- **title** — Title of this entry -- **author** — Who wrote this entry -- **date** — When was this entry written -- **public** — When will this entry be shown to the world -- **content-type** — How is this entry formated (example: "text/html") +Documentation is [currently available as TexInfo](ssg.texi). -- GitLab