Convert from Markdown to Atlassian markup.
$ ./markrust -h
markrust 2.1.0
guppy0130 <[email protected]>
Converts Markdown to Atlassian markup
USAGE:
markrust [OPTIONS] [ARGS]
ARGS:
<INPUT> FILE input, or empty for stdin
<OUTPUT> FILE output, or empty for stdout
OPTIONS:
-e, --editor
Launch $EDITOR as input
-h, --help
Print help information
-l, --language <LANGUAGE>
[default: confluence] [possible values: jira, confluence]
-m, --modify-headers <MODIFY_HEADERS>
Add N to header level (can be negative) [default: 0]
-t, --toc
Prepend TOC markup
-V, --version
Print version information
Compared to the Markdown converter that comes with Atlassian products:
- Code block macro with syntax highlighting
- Code block macro with automatic language mapping
- Console -> bash, language aliases, etc.
- Automatic TOC markup (pass
-t
flag) - Header level modifier (add/remove to header levels across document)
- Limited support for
details
andsummary
HTML elements
markrust -e output
will launch your$EDITOR
with$TMP/markrust.md
as an argument, then when the editor returns, markrust will write the Atlassian markup tooutput
.- You can only supply one path with the
-e
flag as a result
- You can only supply one path with the
- Markdown content in
details
andsummary
will not be parsed, because once you're in HTML, only text will be kept as-is.
cargo test
cargo bench
- coming soonmake coverage
to compute coverage- if you're on Windows, you may want to run
setup_env.ps1
first.
- if you're on Windows, you may want to run