diff --git a/README.md b/README.md index b7fb137..4f5a0c4 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,10 @@ attempts to be a faithful implementation of the It supports mathematical typesetting via [MathJax](https://www.mathjax.org). By utilizing copious partial templates the theme is largely customizable. +## Math + +TODO explain the different ways to write LaTeX. + ## Site Parameters The site specific parameters that this theme :wrecognizes are: @@ -22,8 +26,7 @@ The site specific parameters that this theme :wrecognizes 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. The - theme follows the conventions in [Hugo's MathJax tutorial]. +- `math` boolean: if true, try to render the page's LaTeX code using MatheJax. - `meta` boolean: if true, display page meta-data 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. @@ -43,6 +46,35 @@ This theme provides the following shortcodes. There is nothing more beautiful than an elegant mathematical proof. {{% /blockquote %}}` ``` + +- `div` + - Description: This shortcode is provided as a work-around for wrapping + complex blocks of markdown in div tags. The wrapped text can + include other shortcodes + - Usage: Identical to the `section` shortcode. + Accepts the style parameters `class` and `id`. + If no only the positional argument `"end"` is passed, a closing tag + will be inserted. + - Example: `{{< div class="my-class" >}}` inserts a + `
` tag, while + `{{
}}` inserts the closing `
` tag. + +- `epigraph` + - Description: Create an epigraph with the wrapped text. + - Usage: To include a footer with source attribution, pass in the + optional named parameters `pre`, `cite`, `post`. These parameters are + make no styling assumptions, so spacing is important. A more compactly + styled epigraph will be used if the `type` parameter is set to `compact`. + (This just wraps the content in a paragraph tag.) + - Example: + ```html + {{% epigraph pre="Author Writer, " cite="Math is Fun" %}} + This is an example of an epigraph with some math + \\(\mathbb N \subseteq \mathbb R \\) + to start the beginning of a section. + {{% /epigraph %}} + ``` + - `marginnote` - Description: Wrap text to produce a numberless margin note. - Usage: Accepts a required positional argument that is the margin note id. @@ -51,12 +83,16 @@ This theme provides the following shortcodes. - `section` - Description: This shortcode is provided as a work-around for wrapping - complex blocks of markdown in section tags. - - Usage: `{{< section "" >}}` map respectively to - `
` and `
` tags. - - Example: `{{< section "begin" >}}` inserts a `
` tag, while + complex blocks of markdown in section tags. The wrapped text can + include other shortcodes + - Usage: Accepts the style parameters `class` and `id`. + If no only the positional argument `"end"` is passed, a closing tag + will be inserted. + - Example: `{{< section class="my-class" >}}` inserts a + `
` tag, while `{{
}}` inserts the closing `
` tag. + - `sidenote` - Description: Wrap text to produce an automatically numbered sidenote. - Usage: identical to `marginnote`. diff --git a/layouts/shortcodes/cite.html b/layouts/shortcodes/cite.html new file mode 100644 index 0000000..0c44508 --- /dev/null +++ b/layouts/shortcodes/cite.html @@ -0,0 +1 @@ +{{ .Inner }} diff --git a/layouts/shortcodes/div.html b/layouts/shortcodes/div.html new file mode 100644 index 0000000..2aaa0bd --- /dev/null +++ b/layouts/shortcodes/div.html @@ -0,0 +1,8 @@ +{{ $loc := .Get 0 }} +{{ if .IsNamedParams }} +
+{{ else if or (eq $loc "") (eq $loc "begin") }} +
+{{ else if eq $loc "end" }} +
+{{ end }} diff --git a/layouts/shortcodes/epigraph.html b/layouts/shortcodes/epigraph.html new file mode 100644 index 0000000..2d60ad7 --- /dev/null +++ b/layouts/shortcodes/epigraph.html @@ -0,0 +1,13 @@ +
+
+{{ $t := .Get "type" }} +{{ if eq $t "compact" }}{{ .Inner }}{{ else }}

{{ .Inner }}

{{ end }} +{{ if .IsNamedParams }} +
+{{ with .Get "pre" }}{{ . }}{{ end }} +{{ with .Get "cite" }}{{ . }}{{ end }} +{{ with .Get "post" }}{{ . }}{{ end }} +
+{{ end }} +
+
diff --git a/layouts/shortcodes/section.html b/layouts/shortcodes/section.html index 72fbdbb..fbb0d86 100644 --- a/layouts/shortcodes/section.html +++ b/layouts/shortcodes/section.html @@ -1,9 +1,9 @@ -{{ with .Get 0 }} - {{ if eq . "begin" }} -
- {{ else if eq . "end" }} -
- {{ end }} +{{ $loc := .Get 0 }} +{{ if .IsNamedParams }} +
+{{ else if or (eq $loc "") (eq $loc "begin") }} +
+{{ else if eq $loc "end" }} +
{{ end }} - diff --git a/layouts/shortcodes/tag.html b/layouts/shortcodes/tag.html new file mode 100644 index 0000000..b7d9755 --- /dev/null +++ b/layouts/shortcodes/tag.html @@ -0,0 +1,5 @@ +{{ if .IsNamedParams }} + <{{ .Get "name" }}{{with .Get "class"}} class="{{.}}"{{end}}{{with .Get "id"}} id="{{.}}"{{end}}> +{{ else }} + <{{ .Get 0 }}> +{{ end }}