From 715f2b1a71f1d86b78fa91ff5fbfb528818eef31 Mon Sep 17 00:00:00 2001 From: Jake Worth Date: Wed, 21 Mar 2018 19:48:53 -0500 Subject: [PATCH 1/2] Finish code example and separate action and output --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 5bec65ca..731af9c9 100644 --- a/README.md +++ b/README.md @@ -239,14 +239,14 @@ language as a _class_ attribute of the _code_ tag. For example: - ...> "```elixir", + iex> ["```elixir", ...> " @tag :hello", - ...> "```" ] |> Enum.join("\n") - ...> Earmark.as_html!(code) - "
 @tag :hello
\n" + ...> "```" ] |> Enum.join("\n") |> Earmark.as_html!() will be rendered as + "
 @tag :hello
\n" + If you want to integrate with a syntax highlighter with different conventions you can add more classes by specifying prefixes that will be put before the language string. From 68186d3a07cae712fa50215d7c05e42be8c6e368 Mon Sep 17 00:00:00 2001 From: Jake Worth Date: Wed, 21 Mar 2018 19:49:10 -0500 Subject: [PATCH 2/2] Fix typos --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 731af9c9..9ee347a9 100644 --- a/README.md +++ b/README.md @@ -73,7 +73,7 @@ GFM is supported by default, however as GFM is a moving target and all GFM exten iex(13)> Earmark.as_html! ["~~hello~~"] "

hello

\n" -* Syntax Highlightening +* Syntax Highlighting The generated code blocks have a corresponding `class` attribute: @@ -93,7 +93,7 @@ which can be customized with the `code_class_prefix` option * Tables -Are supported as long as they are preceeded by an empty line. +Are supported as long as they are preceded by an empty line. State | Abbrev | Capital ----: | :----: | ------- @@ -141,7 +141,7 @@ For example: #### To links or images -It is possible to add IAL attributes to genertated links or images in the following +It is possible to add IAL attributes to generated links or images in the following format. iex> markdown = "[link](url) {: .classy}" @@ -232,7 +232,7 @@ containing an IAL-like string, as in the following example ## Integration -### Syntax Highlightning +### Syntax Highlighting All backquoted or fenced code blocks with a language string are rendered with the given language as a _class_ attribute of the _code_ tag.