Warning: Work in progress! Leave feedback on Zulip or Github if you'd like this doc to be updated.
This file is essentially a unit test for doctools/oil_doc.py, which contains all the HTML plugins.
Related: How We Build Oil's Documentation.
$oil-src: INSTALL.txt, INSTALL.txt
$issue: issue 11
$oil-commit: this commit
pre block in a document needs the same higlighter, you can specify
it in the front matter like this:
--- default_highlighter: oil-sh --- My Title ========
Right now we only allow
oil-sh, which is a generic formatter that works for
both shell and Oil code (detail: it's the same as
sh-prompt for now). This
is what we use in idioms.html and known
$ echo hi # comment hi
x = 42 print(x, file=sys.stderr)
A shell session could look like this:
$ echo one $ echo two