Skip to main content

Document-level Options

Alternatively, you can run the entire document in your Markdown file.

Runme does not just retain Frontmatter, it also supports top-level settings that will affect all cells in the document.

Set custom shell​

---
shell: bash
# or
shell: zsh
# or
shell: /bin/ksh
---

Current working directory​

It is not unusual to store docs in a sub-directory, e.g. docs/. It's often implied that commands need to run from the base directory. To reliably execute commands in this case it's handy to explicitly set a working directory in the frontmatter.

---
# relative for file inside of `docs/`
cwd: ..
# absolute works too, however, less commonplace
cwd: /tmp
---