/shell_notebook

Sweet, and super low-tech shell notebooks!

Primary LanguageRubyMIT LicenseMIT

Shell Notebooks

Sweet, and super low-tech shell notebooks!

Write a (simple) Markdown document, then automatically convert it to a runnable shell script and get back a shiny new Markdown document with all of the results!

If you've used an R Markdown notebook before, you know what I mean!

Installation

You'll need to have Ruby installed on your computer.

Then download the run_bash_notebook script and put it somewhere convenient! That particular script will use bash so you'll want to have that as well.

Usage

Example

Try it out!

./run_bash_notebook test_files/test.md

There are a lot more examples describing some of the cool stuff you can do in the test_files directory.

Keep the Markdown basic

I've only tested it with some pretty basic Markdown so far (see test_files/*.md). Who knows how well it'll work with super complicated and spiffier Markdown files ¯\_(ツ)_/¯!

Inspiration

  • bash-notebook -- another option for bash notebooks
  • R Markdown -- 💖 it, but not so smooth for shell focused notebooks!