WARNING

This is documentation for zx v7, which is no longer actively maintained.

For up-to-date documentation, see the latest version (v8).

Markdown Scripts

It's possible to write scripts using markdown. Only code blocks will be executed by zx.

You can run this markdown file:

zx docs/markdown.md

await $`whoami`
await $`echo ${__dirname}`

The __filename will be pointed to markdown.md:

console.log(chalk.yellowBright(__filename))

We can use imports here as well:

await import('chalk')

A bash code (with bash or sh language tags) also will be executed:

VAR=$(date)
echo "$VAR" | wc -c

Other code blocks are ignored:

body .hero {
  margin: 42px;
}