An easy and quick way to start with subtext is to build this
-README:
+README:
make readme#So what does subtext do?
+It takes an input file or stream and converts it to a shell script
+which you can then pipe through sh(1).
+But it doesn't
+just
+do that.
+subtext
+also outputs various functions and variables and what-not
+to set up the environment in which the source document is expanded.
+Starting a line with # puts the rest of the line in the code part,
+enabling you to set a title, say, with or
+define a function for a commonly-used thing in your file.
+For this README, I've written
+#subtext()(code subtext)
+so I save about five characters every time.
.The "text layer" of subtext is actually expanded to a shell here-doc
+so that you can use stuff like
+$(...)
+to call shell functions.
+But don't worry – I've made it easier to not shoot yourself in the foot.
+One $ is changed to \$ in the expansion,
+and more than one $ is changed to one less.
+So $$$ becomes $$, etc.
+if you really want to put the process number in your output.
+Oh, and ` are all escaped.
+Those were a bad idea from go.
In addition, lines beginning with
+.
+expand to
+$(...),
+and lines beginning with
+..COMMAND [ARGS]
+expand to
+$(COMMAND ARGS << ..
+and close the here-doc with
+..
+on a line by itself.
You can add the
+<< END-MARKER
+yourself if you want to specify your own end-marker.
Basically, this means you can write +
.h1 My cool article
+
+Here is a cool article.
+It is
+.i really
+cool.
+
+Here's what someone said about it:
+
+..blockquote cite="A fan"
+Wow, what a cool article!
+..The above translates to
+Here is a cool article. +It is +really +cool.
+Here's what someone said about it:
+Wow, what a cool article!
Since this README was generated from subtext source, +look at readme.st to get a better feel for the syntax.
+ +subtext