Skip to content

Latest commit

 

History

History
101 lines (75 loc) · 2.43 KB

demo.md

File metadata and controls

101 lines (75 loc) · 2.43 KB
Raw

MDRB Demo

This is a sample markdown file which contains several types of content, including:

  • Fenced code blocks tagged with a supported language code, i.e.
    • typescript
    • javascript
    • ts $ js
  • Inline code (like in the previous list)
  • blockquotes
  • lists
  • headings
  • and more!

Hey look, a blockquote just before our first code block!

say hello to the world 
description = '''
basic demonstration of the fact that
you can log to the console with code
blocks.
'''

// I can have comments

const message = "Hello MDRB!";
console.log(message);

Second section

We can also have code blocks which are for unsupported languages, like this one for shell script

echo "I am not going to be run by mdrb, but I don't mind"

Third level heading

Here we have a second fenced code block tagged with a supported language.

say hello to the world again 
description = '''
another logging demo; beware that in this
block, we "re-declare" `message` (safe in both
"runbook" mode and "isolated" mode, but not in
"single" mode).
'''

const message = "Hello (again) MDRB!";
console.log(message);

Notice that these two code blocks each declare a const called message - this is ok, because by default, mdrb runs your fenced ts / js code blocks as if they were isolated and separate script files.

If you want, you can change the mode to run them all together as a single script, but just FYI, if you do that for this file, it'll error because you can't redeclare a const :)

Another cool thing about mdrb is that by default, the dax cross platform shell scripting tools are injected into your script...basically by adding an import to the top of it that you don't have to write yourself. Something like:

import { $ } from 'https://jsr.io/@david/dax@<version>

which means your fenced code blocks have access to a magic $ variable that is the default $ export of the dax module - super handy!

log a final message to standard error 
description = '''
this time, log to standard error!
'''

$.log("heeeeey! this will be printed to stderr :)");

That's it for the quick demo

There's more to try with mdrb, so make sure to read the docs and try it out yourself! Enjoy!