mirrors/hugo-tufte
1
0
Fork 1
mirror of https://github.com/loikein/hugo-tufte.git synced 2024-11-16 21:36:56 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update README.md

Browse source
This commit is contained in:
Shawn O'Hare 2016-02-21 09:56:21 -08:00
parent 975adc8439
commit deece2de9d
1 changed files with 3 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
README.md
View file

@ -54,7 +54,7 @@ The site specific parameters that this theme recognizes are:
- `hideReadTime` boolean: if true, do not display the page's reading time - `hideReadTime` boolean: if true, do not display the page's reading time
estimate. When `meta` is set to true, `hideReadTime` takes greater precedence. 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 meta-data author, date, categories provided - `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, these page parameters exist and are not overridden. Content in the `/post` directory,
(i.e., pages of type "post") ignore this parameter. (i.e., pages of type "post") ignore this parameter.
- `toc` boolean: if true, display the table of contents for the page. - `toc` boolean: if true, display the table of contents for the page.
@ -82,7 +82,7 @@ support all the features present in the
include other shortcodes include other shortcodes
- **Usage**: Identical to the `section` shortcode. - **Usage**: Identical to the `section` shortcode.
Accepts the style parameters `class` and `id`. Accepts the style parameters `class` and `id`.
If no only the positional argument `"end"` is passed, a closing tag If only the positional argument `"end"` is passed, a closing tag
will be inserted. will be inserted.
- **Example**: `{{< div class="my-class" >}}` inserts a - **Example**: `{{< div class="my-class" >}}` inserts a
`<div class="my-class">` tag, while `<div class="my-class">` tag, while
@ -114,7 +114,7 @@ support all the features present in the
complex blocks of markdown in section tags. The wrapped text can complex blocks of markdown in section tags. The wrapped text can
include other shortcodes include other shortcodes
- **Usage**: Accepts the style parameters `class` and `id`. - **Usage**: Accepts the style parameters `class` and `id`.
If no only the positional argument `"end"` is passed, a closing tag If only the positional argument `"end"` is passed, a closing tag
will be inserted. will be inserted.
- **Example**: `{{< section class="my-class" >}}` inserts a - **Example**: `{{< section class="my-class" >}}` inserts a
`<section class="my-class">` tag, while `<section class="my-class">` tag, while