Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cdklabs/markmac
Embed program outputs in markdown
https://github.com/cdklabs/markmac
Last synced: 3 months ago
JSON representation
Embed program outputs in markdown
- Host: GitHub
- URL: https://github.com/cdklabs/markmac
- Owner: cdklabs
- License: apache-2.0
- Created: 2020-10-07T07:03:55.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-08-09T00:25:07.000Z (3 months ago)
- Last Synced: 2024-08-09T03:13:06.291Z (3 months ago)
- Language: TypeScript
- Size: 3.76 MB
- Stars: 17
- Watchers: 15
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# markmac
> Markdown macros - embed program outputs in markdown
Let's say I have a markdown file `test.md` which looks like this:
```test
# Hello, World
This is _just markdown_.
## Current date is:
## Current time is:
```
If I pipe it through `markmac`, the macro commands will be executed and their
STDOUT will be embedded between `` and ``.
```console
$ cat test.md | markmac
# Hello, World
This is _just markdown_.
## Current date is:
10/07/2020
## Current time is:
15:48
```
`markmac` searches for the `` directives inside your markdown file,
executes the command in `exec` and substitutes the contents between ``
and `` with STDOUT.
## Installation
This program is distributed via npm, so it can be installed through `yarn` or
`npm` or any other supporting client:
```shell
npm i -g markmac
```
## License
[Apache 2.0](./LICENSE)