https://github.com/itspriddle/gh-render-markdown

GitHub CLI extension to render markdown document as HTML
https://github.com/itspriddle/gh-render-markdown

gh-extension markdown

Last synced: 16 days ago
JSON representation

GitHub CLI extension to render markdown document as HTML

• Host: GitHub
• URL: https://github.com/itspriddle/gh-render-markdown
• Owner: itspriddle
• License: mit
• Created: 2022-03-16T04:37:19.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2022-03-16T05:51:19.000Z (almost 3 years ago)
• Last Synced: 2024-08-17T08:05:11.178Z (4 months ago)
• Topics: gh-extension, markdown
• Language: Shell
• Homepage:
• Size: 2.93 KB
• Stars: 6
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# gh-render-markdown

[gh][1] extension to render Markdown files as HTML.

[1]: https://cli.github.com/

## Usage

Specify one or more Markdown files to generate as arguments to `gh

render-markdown`:

```sh

gh render-markdown README.md CONTRIBUTING.md

```

Alternatively, STDIN can be used which allows for a few different usage

patterns. For example, you can redirect input:

```sh

gh render-markdown < README.md

```

Or pipe a command that outputs Markdown:

```sh

echo '# markdown' | gh render-markdown

```

Or pass raw Markdown directly via input:

```sh

gh render-markdown <<< '# markdown'

```

Or manually type a blob of Markdown yourself by opening STDIN (press Ctrl-D

when done):

```sh

gh render-markdown

# markdown

^D

```

## Installation

```sh

gh extension install itspriddle/gh-render-markdown

```

## Bug Reports

Issues can be reported on GitHub:

## License

MIT License - see [`LICENSE`](./LICENSE) in this repository.