Markdown code execution (2024)
ADR started in September 2024.
Context and problem statement
As a technical writer, I want to be able to execute the code blocks included in a Markdown page so that I can improve the user experience of the person that will be following the documentation.
Requirements
- Execute in one click the code in a terminal that would have been opened and selected before
- Must work in Visual Studio Code or integrated in a solution to provide the HTML from the Markdown
- Technical solution must be free of charge
Considered options
| Name | Source code | IDE |
|---|---|---|
| Runme | coder/code-server ★ 1.1k | Visual Studio Code |
| Code Runner | formulahendry/vscode-code-runner ★ 2.2k | Visual Studio Code |
Decision outcome
⛵ Experimentation in progress!
- 🟠 Runme looks cool and brings the concept of Notebook, but is limited and has some bugs
- 🔴 Code Runner is only for code in a sandbox, not on an actual terminal