https://github.com/rmariuzzo/markdown-exec
Execute commands in your Markdown and keep the output.
https://github.com/rmariuzzo/markdown-exec
cli exec markdown markdown-parser
Last synced: 8 months ago
JSON representation
Execute commands in your Markdown and keep the output.
- Host: GitHub
- URL: https://github.com/rmariuzzo/markdown-exec
- Owner: rmariuzzo
- License: mit
- Created: 2018-01-04T19:43:04.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2018-01-09T17:22:41.000Z (about 8 years ago)
- Last Synced: 2025-05-26T15:04:21.333Z (9 months ago)
- Topics: cli, exec, markdown, markdown-parser
- Language: JavaScript
- Size: 35.2 KB
- Stars: 5
- Watchers: 2
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Installation
```shell
yarn add markdown-exec --global
```
or
```shell
npm install markdown-exec --global
```
# Usage
The `markdown-exec` command takes one single argument: a file containing [XML Comment API](https://github.com/rmariuzzo/xml-comment-api)'s annotations.
```shell
markdown-exec ./README.md
```
The command will process the content of the given file and will search for XML comments that has the following format:
```xml
```
## Specify command to execute
**Before:**
```xml
```
**After:**
```xml
123
```
## Use a regular expression to reduce the command output
**Before:**
```xml
```
**After:**
```xml
123
```
## Tests
- `yarn test` - run all tests once.
- `yarn test -- --watch` - run all tests and watch for changes.
## Development
To start contributing to this project, please do:
1. [Fork and clone this repo](https://github.com/rmariuzzo/markdown-exec/fork).
2. Do your work.
3. Create a PR.
## Releases
To release this project the following tasks should be done:
1. Using [np](https://github.com/sindresorhus/np): `np`
Made with :heart: by [Rubens Mariuzzo](https://github.com/rmariuzzo).
[MIT License](LICENSE)