Skip to content

Commit 3421af3

Browse files
kivikakkkivikakk
committed
0.15.0
1 parent 8caec3f commit 3421af3

File tree

4 files changed

+102
-43
lines changed

4 files changed

+102
-43
lines changed

‎Cargo.lock‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎Cargo.toml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[package]
22
name = "comrak"
3-
version = "0.14.0"
4-
authors = ["Ashe Connor <[email protected]>"]
3+
version = "0.15.0"
4+
authors = ["Asherah Connor <[email protected]>"]
55
description = "A 100% CommonMark-compatible GitHub Flavored Markdown parser and formatter"
66
documentation = "https://docs.rs/comrak"
77
homepage = "https://github.com/kivikakk/comrak"

‎README.md‎

Lines changed: 83 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Specify it as a requirement in `Cargo.toml`:
2222

2323
``` toml
2424
[dependencies]
25-
comrak = "0.14"
25+
comrak = "0.15"
2626
```
2727

2828
Comrak supports Rust stable.
@@ -43,47 +43,90 @@ curl.exe -A "MS" https://webinstall.dev/comrak | powershell
4343

4444
``` console
4545
$ comrak --help
46-
comrak 0.14.0
47-
Ashe Connor <[email protected]>
4846
A 100% CommonMark-compatible GitHub Flavored Markdown parser and formatter
4947

50-
USAGE:
51-
comrak [FLAGS] [OPTIONS] [--] [FILE]...
52-
53-
FLAGS:
54-
--escape Escape raw HTML instead of clobbering it
55-
--gfm Enable GitHub-flavored markdown extensions strikethrough, tagfilter, table, autolink, and
56-
tasklist. It also enables --github-pre-lang.
57-
--github-pre-lang Use GitHub-style <pre lang> for code blocks
58-
--hardbreaks Treat newlines as hard line breaks
59-
-h, --help Prints help information
60-
--smart Use smart punctuation
61-
--unsafe Allow raw HTML and dangerous URLs
62-
-V, --version Prints version information
63-
64-
OPTIONS:
65-
-c, --config-file <PATH> Path to config file containing command-line arguments, or `none'
66-
[default: /Users/kivikakk/.config/comrak/config]
67-
--default-info-string <INFO> Default value for fenced code block's info strings if none is given
68-
-e, --extension <EXTENSION>... Specify an extension name to use [possible values: strikethrough,
69-
tagfilter, table, autolink, tasklist, superscript, footnotes,
70-
description-lists]
71-
-t, --to <FORMAT> Specify output format [default: html] [possible values: html,
72-
commonmark]
73-
--front-matter-delimiter <DELIMITER> Ignore front-matter that starts and ends with the given string
74-
--header-ids <PREFIX> Use the Comrak header IDs extension, with the given ID prefix
75-
--list-style <LIST_STYLE> Specify bullet character for lists (-, +, *) in CommonMark ouput
76-
[default: dash] [possible values: dash, plus, star]
77-
-o, --output <FILE> Write output to FILE instead of stdout
78-
--syntax-highlighting <THEME> Syntax highlighting for codefence blocks. Choose a theme or 'none' for
79-
disabling. [default: base16-ocean.dark]
80-
--width <WIDTH> Specify wrap width (0 = nowrap) [default: 0]
81-
82-
ARGS:
83-
<FILE>... The CommonMark file to parse; or standard input if none passed
84-
85-
By default, Comrak will attempt to read command-line options from a config file specified by --config-file. This
86-
behaviour can be disabled by passing --config-file none. It is not an error if the file does not exist.
48+
Usage: comrak [OPTIONS] [FILE]...
49+
50+
Arguments:
51+
[FILE]...
52+
CommonMark file(s) to parse; or standard input if none passed
53+
54+
Options:
55+
-c, --config-file <PATH>
56+
Path to config file containing command-line arguments, or 'none'
57+
58+
[default: /Users/kivikakk/.config/comrak/config]
59+
60+
--hardbreaks
61+
Treat newlines as hard line breaks
62+
63+
--smart
64+
Use smart punctuation
65+
66+
--github-pre-lang
67+
Use GitHub-style <pre lang> for code blocks
68+
69+
--gfm
70+
Enable GitHub-flavored markdown extensions: strikethrough, tagfilter, table, autolink, and
71+
tasklist. Also enables --github-pre-lang
72+
73+
--default-info-string <INFO>
74+
Default value for fenced code block's info strings if none is given
75+
76+
--unsafe
77+
Allow raw HTML and dangerous URLs
78+
79+
--escape
80+
Escape raw HTML instead of clobbering it
81+
82+
-e, --extension <EXTENSION>
83+
Specify extension name(s) to use
84+
85+
Multiple extensions can be delimited with ",", e.g. --extension strikethrough,table
86+
87+
[possible values: strikethrough, tagfilter, table, autolink, tasklist, superscript,
88+
footnotes, description-lists]
89+
90+
-t, --to <FORMAT>
91+
Specify output format
92+
93+
[default: html]
94+
[possible values: html, commonmark]
95+
96+
-o, --output <FILE>
97+
Write output to FILE instead of stdout
98+
99+
--width <WIDTH>
100+
Specify wrap width (0 = nowrap)
101+
102+
[default: 0]
103+
104+
--header-ids <PREFIX>
105+
Use the Comrak header IDs extension, with the given ID prefix
106+
107+
--front-matter-delimiter <DELIMITER>
108+
Ignore front-matter that starts and ends with the given string
109+
110+
--syntax-highlighting <THEME>
111+
Syntax highlighting for codefence blocks. Choose a theme or 'none' for disabling
112+
113+
[default: base16-ocean.dark]
114+
115+
--list-style <LIST_STYLE>
116+
Specify bullet character for lists (-, +, *) in CommonMark ouput
117+
118+
[default: dash]
119+
[possible values: dash, plus, star]
120+
121+
-h, --help
122+
Print help information (use `-h` for a summary)
123+
124+
-V, --version
125+
Print version information
126+
127+
By default, Comrak will attempt to read command-line options from a config file specified by
128+
--config-file. This behaviour can be disabled by passing --config-file none. It is not an error if
129+
the file does not exist.
87130
```
88131

89132
And there's a Rust interface. You can use `comrak::markdown_to_html` directly:

‎changelog.txt‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,19 @@
1+
### 0.15.0
2+
3+
* table: fix start_line of Table itself by @kivikakk in https://github.com/kivikakk/comrak/pull/231
4+
* Rename header file to match c libname by @gjtorikian in https://github.com/kivikakk/comrak/pull/233
5+
* Change the name of the ifdef by @gjtorikian in https://github.com/kivikakk/comrak/pull/234
6+
* Add `comrak_set_parse_option_smart` by @gjtorikian in https://github.com/kivikakk/comrak/pull/235
7+
* Allow `c_char` options to be NULL by @gjtorikian in https://github.com/kivikakk/comrak/pull/237
8+
* Replace `lazy_static` dependency with `once_cell` by @Turbo87 in https://github.com/kivikakk/comrak/pull/238
9+
* Make `comrak --help` readable on my terminal by @mgeisler in https://github.com/kivikakk/comrak/pull/242
10+
* c-api: fix CI build by @kivikakk in https://github.com/kivikakk/comrak/pull/240
11+
* Bump versions of some dependencies by @helmet91 in https://github.com/kivikakk/comrak/pull/243
12+
* Adding functionality to build SyntectAdapters with custom themes, syntax sets, etc. by @ArvinSKushwaha in https://github.com/kivikakk/comrak/pull/239
13+
* Make shell-words and xdg dependencies optional by @silverpill in https://github.com/kivikakk/comrak/pull/245
14+
* Bump clap version to 4.0 and switch to the Derive API by @tranzystorek-io in https://github.com/kivikakk/comrak/pull/248
15+
* c-api: remove by @kivikakk in https://github.com/kivikakk/comrak/pull/249
16+
117
### 0.14.0
218

319
* Add C FFI, allowing Comrak to be used from other languages. (#171, Garen

0 commit comments

Comments
 (0)