Skip to content

Commit

Permalink
Merge branch 'main' of github.com:bert-github/gf-markdown-awk
Browse files Browse the repository at this point in the history
  • Loading branch information
bert-github committed Jun 4, 2023
2 parents 595a20a + 443b49b commit f5bca78
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ There are several programs that convert markdown ([GitHub-flavored markdown](htt

It's not a program, but a library. (Although it only requires three lines to make it a program, see above). And in particular it is a library for *Awk.* It is meant for people who need to add markdown support to an Awk program.

You could, of course, call an external program from your Awk script to convert markdown to HTML. But this library provides two extra functions that may occasionally be handy and that existing programs don't provide. (At least I haven't found any.) And that is the ability to parse inline markdown only, i.e., bold, italics, links, etc., while ignoring paragraphsm lists, etc.; and the ability to strip markdown from text to retain just the plain text content.
You could, of course, call an external program from your Awk script to convert markdown to HTML. But this library provides two extra functions that may occasionally be handy and that existing programs don't provide. (At least I haven't found any.) And that is the ability to parse inline markdown only, i.e., bold, italics, links, etc., while ignoring paragraphs, lists, etc.; and the ability to strip markdown from text to retain just the plain text content.

The former is provided by the function `markdown::to_inline_html()`, the latter by the function `markdown::to_text()`.

Expand Down

0 comments on commit f5bca78

Please sign in to comment.