markdown-code-runner 0.1.0

Automatically update Markdown files with code block output
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146

# markdown-code-runner

A Rust implementation of [markdown-code-runner](https://github.com/basnijholt/markdown-code-runner) - automatically update Markdown files with code block output.

## Installation

```bash
cargo install markdown-code-runner
```

Or build from source:

```bash
git clone https://github.com/basnijholt/markdown-code-runner-rs
cd markdown-code-runner-rs
cargo install --path .
```

## Usage

```bash
markdown-code-runner [OPTIONS] <INPUT>

Arguments:
  <INPUT>  Path to the input Markdown file

Options:
  -o, --output <OUTPUT>          Path to the output Markdown file (default: overwrite input file)
  -d, --verbose                  Enable verbose/debug mode
      --no-backtick-standardize  Disable backtick standardization
  -s, --standardize              Post-process to standardize ALL code fences
  -n, --no-execute               Skip code execution entirely
  -h, --help                     Print help
  -V, --version                  Print version
```

## Markdown Syntax

### Backtick Code Blocks

Add `markdown-code-runner` after the language identifier to mark a code block for execution:

~~~markdown
```python markdown-code-runner
print('Hello, world!')
```
<!-- OUTPUT:START -->
This will be replaced by the output.
<!-- OUTPUT:END -->
~~~

### Hidden Code Blocks (HTML Comments)

Use HTML comments to hide the code while still executing it:

```markdown
<!-- CODE:START -->
<!-- print('Hello, world!') -->
<!-- CODE:END -->
<!-- OUTPUT:START -->
This will be replaced by the output.
<!-- OUTPUT:END -->
```

For Bash:

```markdown
<!-- CODE:BASH:START -->
<!-- echo "Hello from bash!" -->
<!-- CODE:END -->
<!-- OUTPUT:START -->
This will be replaced by the output.
<!-- OUTPUT:END -->
```

### Skip Marker

Use `<!-- CODE:SKIP -->` to prevent execution of the next code block:

~~~markdown
<!-- CODE:SKIP -->
```python markdown-code-runner
print('This will not be executed')
```
<!-- OUTPUT:START -->
This output will be preserved.
<!-- OUTPUT:END -->
~~~

### Write to File

Use the `filename=` option to write code to a file instead of executing:

~~~markdown
```rust markdown-code-runner filename=example.rs
fn main() {
    println!("Hello, Rust!");
}
```
<!-- OUTPUT:START -->
<!-- OUTPUT:END -->
~~~

## Variable Persistence

Variables defined in Python code blocks are shared across all subsequent Python blocks in the same file:

~~~markdown
```python markdown-code-runner
x = 42
print(x)
```
<!-- OUTPUT:START -->
42
<!-- OUTPUT:END -->

```python markdown-code-runner
print(x * 2)
```
<!-- OUTPUT:START -->
84
<!-- OUTPUT:END -->
~~~

## Indented Code Blocks

Code blocks in list items or other indented contexts are supported:

~~~markdown
1. Example:

    ```python markdown-code-runner
    print('indented')
    ```
    <!-- OUTPUT:START -->
    indented
    <!-- OUTPUT:END -->
~~~

## License

MIT License - see [LICENSE](LICENSE) for details.

## Related

- [markdown-code-runner](https://github.com/basnijholt/markdown-code-runner) - The original Python implementation