diff --git a/README.md b/README.md index 12d08ac..785bbe8 100644 --- a/README.md +++ b/README.md @@ -13,8 +13,8 @@ Mathjax renders LaTeX written inside of markdown files. LaTeX can be written more or less as normal, but inline and display environments that start with `\` must be escaped. Some examples: -- `This $\LaTeX$ will be rendered inline.` -- `This \\(\LaTeX\\) will be rendered inline.` +- `This $\LaTeX$ will be rendered inline.` +- `This \\(\LaTeX\\) will be rendered inline.` - `A simple displayed equation: $$f(x, y) := e^{x^2 - y^2}.$$` - `A simple displayed equation: \\[f(x, y) := e^{x^2 - y^2}.\\]` @@ -53,7 +53,7 @@ The site specific parameters that this theme recognizes are: true, `hideDate` takes greater precedence. - `hideReadTime` boolean: if true, do not display the page's reading time estimate. When `meta` is set to true, `hideReadTime` takes greater precedence. -- `math` boolean: if true, try to render the page's LaTeX code using MatheJax. +- `math` boolean: if true, try to render the page's LaTeX code using MatheJax. - `meta` boolean: if true, display page metadata such as author, date, categories provided these page parameters exist and are not overridden. Content in the `/post` directory, (i.e., pages of type "post") ignore this parameter. @@ -62,17 +62,17 @@ The site specific parameters that this theme recognizes are: ## Shortcodes This theme provides the following shortcodes in an attempt to completely -support all the features present in the +support all the features present in the [Tufte-css](https://github.com/edwardtufte/tufte-css) project. - `blockquote` - **Description**: Wrap text in a blockquote and insert optional `cite` or `footer` metadata. - **Usage**: Accepts the named parameters `cite` and `footer`. - - **Example**: + - **Example**: ```html {{% blockquote cite="www.shawnohare.com" footer="Shawn" %}} - There is nothing more beautiful than an elegant mathematical proof. + There is nothing more beautiful than an elegant mathematical proof. {{% /blockquote %}}` ``` @@ -84,20 +84,20 @@ support all the features present in the Accepts the style parameters `class` and `id`. If only the positional argument `"end"` is passed, a closing tag will be inserted. - - **Example**: `{{< div class="my-class" >}}` inserts a + - **Example**: `{{< div class="my-class" >}}` inserts a `