about summary refs log tree commit diff stats
path: root/readme.md
diff options
context:
space:
mode:
authorCase Duckworth2024-02-01 23:52:57 -0600
committerCase Duckworth2024-02-01 23:52:57 -0600
commit54e07f822b463c8d461fef254213f83c59d82810 (patch)
treef5f8d7e6375653113b6aaef2e12905b4a7d26334 /readme.md
parentuhh (diff)
downloadsubtext-54e07f822b463c8d461fef254213f83c59d82810.tar.gz
subtext-54e07f822b463c8d461fef254213f83c59d82810.zip
Refactor for interleaved shell commands and text
Diffstat (limited to 'readme.md')
-rw-r--r--readme.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..46c5943 --- /dev/null +++ b/readme.md
@@ -0,0 +1,20 @@
1# subtext
2## a layered roffish markup .. thing
3
4subtext is a way to write text using shell templating and roff-like aesthetics for fun. confused? I don't know how to describe it really. just look at the syntax, i guess.
5
6## syntax
7
8subtext's syntax is inspired by roff mostly, with some other line-oriented markups in there as well. its semantics are mostly inspired by this one program i read about reading files as shell here-docs. i kinda combined those ideas together to make an awk script that generates a shell script that you can execute to generate markup. i will *eventually* have html and gemtext macrofiles in this repo, so you can generate html and gemtext from the same source file.
9
10### text lines
11
12### shell substitution
13
14### dotted lines
15
16### hashed lines
17
18## what's a macrofile?
19
20note: i should probably change this name