https://github.com/yammerjp/mdrun

mdrun: Task runner for commands defined in markdown
https://github.com/yammerjp/mdrun

markdown taskrunner

Last synced: 3 months ago
JSON representation

mdrun: Task runner for commands defined in markdown

• Host: GitHub
• URL: https://github.com/yammerjp/mdrun
• Owner: yammerjp
• License: mit
• Created: 2023-02-26T07:34:57.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2023-02-26T11:28:19.000Z (almost 3 years ago)
• Last Synced: 2024-12-28T08:19:14.139Z (about 1 year ago)
• Topics: markdown, taskrunner
• Language: Go
• Homepage:
• Size: 1.76 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# mdrun: Task runner for commands defined in markdown

mdrun is a task runner that uses an ambiguous search to select and execute commands defined in code blocks in markdown files such as README.md.

![demo](demo.gif)

## Setup

```

$ go install github.com/yammerjp/mdrun@latest

```

## Run

### List Commands

```

$ mdrun list

```

### Show a Command

```

$ mdrun --dry-run

```

### Run a Command

```

$ mdrun

```

### Help

```

$ mdrun --help

```

### Specify Task Defined Markdown File

```

$ mdrun --target path/to/markdownfile.md

```

## Development

### test

```

$ go test ./...

```