diff options
author | Case Duckworth | 2019-07-01 16:54:16 -0500 |
---|---|---|
committer | Case Duckworth | 2019-07-01 16:54:16 -0500 |
commit | f82c09b9070ebb576638ab7504f21b697e2eecfc (patch) | |
tree | 258ad42e4471d2db2c7ae3b121515c390c2e28f7 | |
parent | Fix typo (diff) | |
download | unk-f82c09b9070ebb576638ab7504f21b697e2eecfc.tar.gz unk-f82c09b9070ebb576638ab7504f21b697e2eecfc.zip |
Update README
-rw-r--r-- | README.md | 30 |
1 files changed, 15 insertions, 15 deletions
diff --git a/README.md b/README.md index ef7f827..ea34785 100644 --- a/README.md +++ b/README.md | |||
@@ -9,19 +9,19 @@ that all fits with 1000 bytes. | |||
9 | There are three main scripts: | 9 | There are three main scripts: |
10 | 10 | ||
11 | <ul> | 11 | <ul> |
12 | <li><strong>UNK</strong>, a bash script that applies the template | 12 | <li><strong>UNK</strong> (250 bytes), a bash script that applies |
13 | to each page and publishes them to the output dir,</li> | 13 | the template to each page and publishes them to the output dir,</li> |
14 | <li><strong>LHT</strong>, an awk script that serves as a (very) basic | 14 | <li><strong>LHT</strong> (241 bytes), an awk script that serves as |
15 | markup language, and</li> | 15 | a (very) basic markup language, and</li> |
16 | <li><strong>TM</strong>, | 16 | <li><strong>TM</strong> (509 bytes), |
17 | the default template script for <strong>UNK</strong>.</li> | 17 | the default template script for <strong>UNK</strong>.</li> |
18 | </ul> | 18 | </ul> |
19 | 19 | ||
20 | __UNK__ and __LHT__ are 250 bytes each, for a total of 500 bytes. | ||
21 | __TM__ takes up the remaining 500 bytes | ||
22 | of the target 1000 bytes. | ||
23 | You are, of course, free to make the template file as large | 20 | You are, of course, free to make the template file as large |
24 | and involved as you like. | 21 | and involved as you like, but it's pretty good already: it has a plain |
22 | (based on <a href="https://jrl.ninja/etc/1/">this article</a>) default CSS, | ||
23 | or will use `S/css.css`, and it automatically adds a list of posts to | ||
24 | the index, or a *return* link to other pages. | ||
25 | 25 | ||
26 | <h1>DETAILS</h1> | 26 | <h1>DETAILS</h1> |
27 | 27 | ||
@@ -52,18 +52,14 @@ Content goes into the following (hard-coded) directories: | |||
52 | If there is no __TM__ in the directory where __UNK__ is run, | 52 | If there is no __TM__ in the directory where __UNK__ is run, |
53 | one will be created that will simply `cat` the file being processed. | 53 | one will be created that will simply `cat` the file being processed. |
54 | 54 | ||
55 | The following variables are made available to __TM__: | 55 | The following variable is made available to __TM__: |
56 | 56 | ||
57 | <ul> | 57 | <ul> |
58 | <li><strong>FN</strong>: the <em>FileName</em> | 58 | <li><strong>FN</strong>: the <em>FileName</em> |
59 | (with directories removed) of the file being processed</li> | 59 | (with directories removed) of the file being processed</li> |
60 | <li><strong>TT</strong>: the <em>TiTle</em> | ||
61 | (the first line) of the file</li> | ||
62 | <li><strong>BD</strong>: the <em>BoDy</em> | ||
63 | (the rest) of the file</li> | ||
64 | </ul> | 60 | </ul> |
65 | 61 | ||
66 | as well as this function: | 62 | as well as these functions: |
67 | 63 | ||
68 | <ul> | 64 | <ul> |
69 | <li><strong>X</strong>, for <em>eXpand</em>: | 65 | <li><strong>X</strong>, for <em>eXpand</em>: |
@@ -73,6 +69,10 @@ as well as this function: | |||
73 | (or if it nests templates, one of the nested ones) | 69 | (or if it nests templates, one of the nested ones) |
74 | has a <code>ZZ</code> on a line by itself, | 70 | has a <code>ZZ</code> on a line by itself, |
75 | due to its <code>heredoc</code> nature.</li> | 71 | due to its <code>heredoc</code> nature.</li> |
72 | <li><strong>T</strong>, for <em>Title</em>: | ||
73 | it'll return the first line of the current file.</li> | ||
74 | <li><strong>B</strong>, for <em>Body</em>: | ||
75 | it'll return all lines *but* the first of the current file.</li> | ||
76 | </ul> | 76 | </ul> |
77 | 77 | ||
78 | and these aliases (though they're more an artefact of saving space | 78 | and these aliases (though they're more an artefact of saving space |