Skip to content

Commit f065fbb

Browse files
authored
readme: Capitalize the word markdown
Markdown is a proper noun.
1 parent c0ad650 commit f065fbb

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

‎README.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,15 +15,15 @@ This repository houses a collection of [Goldmark] extensions created by the [Hug
1515

1616
[![GoDoc](https://godoc.org/github.com/gohugoio/hugo-goldmark-extensions/passthrough?status.svg)](https://godoc.org/github.com/gohugoio/hugo-goldmark-extensions/passthrough)
1717

18-
Use this extension to preserve raw markdown within delimited snippets of text. This was initially developed to support [LaTeX] mixed with markdown, specifically mathematical expressions and equations.
18+
Use this extension to preserve raw Markdown within delimited snippets of text. This was initially developed to support [LaTeX] mixed with Markdown, specifically mathematical expressions and equations.
1919

20-
For example, to preserve raw markdown for inline snippets delimited by the `$` character:
20+
For example, to preserve raw Markdown for inline snippets delimited by the `$` character:
2121

2222
Markdown|Default rendering|Passthrough rendering
2323
:--|:--|:--
2424
`a $_text_$ snippet`|`a $<em>text</em>$ snippet`|`a $_text_$ snippet`
2525

26-
In the markdown example above, the underscores surrounding the word "text" signify emphasis. The markdown renderer wraps the word within `em` tags as required by the [CommonMark] specification. In comparison, the passthrough extension preserves the text within and including the delimiters.
26+
In the Markdown example above, the underscores surrounding the word "text" signify emphasis. The Markdown renderer wraps the word within `em` tags as required by the [CommonMark] specification. In comparison, the passthrough extension preserves the text within and including the delimiters.
2727

2828
Why is this important? Consider this example of a mathematical equation written in LaTeX:
2929

0 commit comments

Comments
 (0)