source | all docs for version 0.8.11 | all versions | oilshell.org

Warning: Work in progress! Leave feedback on Zulip or Github if you'd like this doc to be updated.

Examples of HTML Plugins

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.

Link Shortcuts with $

• $xref: bash
• $blog-tag: oil-release
• $oil-src: INSTALL.txt, INSTALL.txt
• $blog-code-src: interactive-shell/README.md
• $issue: issue 11
• $oil-commit: this commit

Syntax Highlighting Specified In Front matter

If every 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 differences.

Syntax Highlighting With Fenced Code Blocks

sh-prompt

$ echo hi   # comment
hi

Pygments

Plugins We Should Have

• Side-by-side sh and Oil
• Side-by-side PCRE and Eggex
• sh-session - How to replace the data?

A shell session could look like this:

$ echo one
$ echo two

Embeddings:

• Embed Image Preview of Web Page?
• Embed Github Commit?
• Graphviz
  • LaTeX (although I don't really use it)