phil/hugo-tufte
1
0
Fork 0
forked from mirrors/hugo-tufte
Code Pull requests Activity

Updated epigraph docs

Browse source 
- `link` parameter added (pr #11)
This commit is contained in:
slashformotion 2021-08-02 09:38:58 +02:00
parent 3d14a3cc3e
commit 835a8701f8
1 changed files with 2 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
README.md
View file

@ -98,12 +98,12 @@ support all the features present in the
- `epigraph` - `epigraph`
- **Description**: Create an epigraph with the wrapped text. - **Description**: Create an epigraph with the wrapped text.
- **Usage**: To include a footer with source attribution, pass in the - **Usage**: To include a footer with source attribution, pass in the
optional named parameters `pre`, `cite`, `post`. These parameters optional named parameters `pre`, `cite`, `post`, `link`. These parameters
make no styling assumptions, so spacing is important. A more compactly make no styling assumptions, so spacing is important. A more compactly
styled epigraph will be used if the `type` parameter is set to `compact`. styled epigraph will be used if the `type` parameter is set to `compact`.
- **Example**: - **Example**:
```html ```html
{{< epigraph pre="Author Writer, " cite="Math is Fun" >}} {{< epigraph pre="Author Writer, " cite="Math is Fun" link='https://www.google.com' >}}
This is an example of an epigraph with some math This is an example of an epigraph with some math
$ \mathbb N \subseteq \mathbb R $ $ \mathbb N \subseteq \mathbb R $
to start the beginning of a section. to start the beginning of a section.