https://github.com/evilmonkeyinc/markdownconverter
Golang based CLI tool for converting Markdown to other formats
https://github.com/evilmonkeyinc/markdownconverter
markdown slack slackify
Last synced: 5 months ago
JSON representation
Golang based CLI tool for converting Markdown to other formats
- Host: GitHub
- URL: https://github.com/evilmonkeyinc/markdownconverter
- Owner: evilmonkeyinc
- Created: 2022-06-19T07:49:26.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2025-12-14T05:06:46.000Z (6 months ago)
- Last Synced: 2025-12-16T07:19:38.745Z (6 months ago)
- Topics: markdown, slack, slackify
- Language: Go
- Homepage:
- Size: 40 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[](https://codecov.io/gh/evilmonkeyinc/markdownconverter)
[](https://github.com/evilmonkeyinc/markdownconverter/actions/workflows/push_main.yml)
[](https://pkg.go.dev/github.com/evilmonkeyinc/markdownconverter)
# Markdown Converter
A simple command line tool that can perform markdown conversion to other formats
# Supported Formats
## Slack
A simple conversion between markdown and Slack markup (also known as `mrkdwn`).
Designed to be in the correct format for sending via the [Slack API](https://api.slack.com/methods/chat.postMessage) as `text` with `mrkdwn` set to true.
Slack `mrkdown` does not support all the features of markdown, as such some thing are not persisted perfectly such as different header levels or tables but this conversion should be enough for basic use cases such as posting a change-log or simple readme to a Slack message.
## HTML
A conversion between markdown and HTML, using the standard [gomarkdown/markdown](https://github.com/gomarkdown/markdown) `ToHTML` function with default options.
# Usage
## Command Line
```
Usage:
markdownconverter [format] [input] [output]
Example:
markdownconverter slack "[evilmonkeyinc](https://github.com/evilmonkeyinc)"
>
Options:
-f, --format string The output format
-i, --input string The input source file
-o, --output string The output destination file. optional
```
Download the latest version for your OS/Arch from the [Releases](https://github.com/evilmonkeyinc/markdownconverter/releases) page.
You can execute the tool from the command line with the following commands.
1. help - outputs the usage for the tool. You can also use the `--help`, or `-h` flag
2. version - outputs the version of the tool.
3. [format] [input] [output] - formats the input and returns it to the defined output file. If the output is not defined, it will be outputted to standard-out.
The arguments `format`, `input`, and `output` can be defined using flags with the same name if you want to change the order of arguments or just prefer using flags.
## Golang Module
Import `github.com/evilmonkeyinc/markdownconverter` into your golang project.
You can create a new instance of the `slack` or `http` converter by importing the specific package, and calling the exported `New()` function, which exposes the `Parse()` function which will take your markdown input and return the converted output.
```golang
...
import "github.com/evilmonkeyinc/markdownconverter/slack"
...
func main(){
var inputBytes []byte
// get your input
...
converter := slack.New()
outputBytes, err := converter.Parse(inputBytes)
// use your output
}
```