A guide to everything in Oils (in progress).
Go back to All Docs on Oils for design docs and tutorials.
Oils consists of two major "modes" for shell:
They link to topics within these 12 chapters:
The idea is that you can use OSH by itself, YSH by itself, or upgrade OSH to YSH.
help builtin command
When you type
help in OSH or YSH, the command shows some of this material,
and prints hyperlinks to it.
There are 3 levels in this tree of docs, which underlies the
<h2> heading in a chapter
<h3> heading in a chapter.
help builtin "cards", either as inline
text, or a URL to online HTML. A card may also have a URL to POSIX or bash
The source code is simply a tree of Markdown files:
release-index.md # /release/$VERSION/
index.md # All Docs on Oils, /release/$VERSION/doc/
index.md # this page, the Oils Reference
toc-osh.md # link to OSH topics
toc-ysh.md # link to YSH topics
chap-cmd-lang.md # chapter on the command language
And the URLs basically mirror the source code:
You can link to topics with internal anchors: