1 files changed, 40 insertions(+), 0 deletions(-)

M index.html

@@ 4,3 4,43 @@
 I'm testing out a static site generator that can fit in a toot.
 It's called tssg, for <i>toot (or tiny) static site generator</i>.
 I can come up with a better name later.
+<h2>What it does</h2>
+<p>
+For now, tssg takes a group of html files,
+prepends a header (in <code>hd.txt</code>)
+and appends a footer (in <code>ft.txt</code>) to each of them,
+and publishes them to <code>out/</code>.
+Then,
+it generates an index.html file using the same method as above,
+but <i>also</i> appends a table of contents as an unordered list.
+You can see it below.
+<h2>weak spots</h2>
+<ul>
+    <li>tssg doesn't have any sort of dependency checking.
+        it regenerates every page every time, which is probably fine
+        for small sites, but obviously not for large ones.</li>
+    <li>relatedly, tssg doesn't clean up after itself.</li>
+    <li><code>index.html</code> is, itself, included in the generated toc.
+        right now, I've taken care of it with a hack in the css in hd.txt,
+        but the index should ideally not even be a member of the toc.</li>
+    <li>The title you can see on this page and the others is the actual
+        <code>&lt;title&gt;</code> element, which means that on some browsers
+        (including mine) it'll include some trash from browser extensions.
+        It also means that I have a <code>*{display:block;}</code> rule
+        in my css, which causes the <b>~idiosyncratic~</b> styling you see
+        here.</li>
+</ul>
+<h2>wishlist</h2>
+<ul>
+    <li>Remove deleted pages from out/, either by rm-ing the whole directory
+        or by rsync-ing things.
+        Probably rm-ing.</li>
+    <li>Parse first line of source files as a title, and add a
+        <code>&lt;h1&gt;</code> tag to the generated page's body.</li>
+    <li>Possibly enable hd.txt and ft.txt to be shell scripts,
+        which would make many problems more solvable at the possible risk
+        of only <em>technically</em> fitting the whole ssg on a toot.</li>
+    <li>Maybe change the name, maybe to <b>sausage</b>,
+        for the embedded "ssg" and the idea of
+        <q>seeing how the sausage gets made.</q></li>
+</ul>