Documentation

mdsh runs the code blocks in a markdown file, like a notebook whose file format is plain markdown. Start with the install guide, then read about the document format.

• Getting startedInstall mdsh and run your first document.
• Writing documentsBlocks, attributes, front matter, output kinds and includes.
• Front matterEvery document-wide option under the mdsh key.
• EnvironmentsHow blocks share state, and how sub-envs keep it apart.
• Conditions and placeholdersSwitch blocks and sections on and off, and quote results in prose.
• Command lineEvery way to run a document.
• Interactive modeOpen a document in a terminal UI and run its blocks as you go.
• Desktop appmdsh in a window of its own, on macOS and Linux.
• PDF outputShare a run as a PDF report.