hugo-tufte
所属分类：collect
开发工具：CSS
文件大小：0KB
下载次数：0
上传日期：2023-05-16 16:37:17
上 传 者：
sh-1993
说明： 以内容为中心的Hugo博客主题，采用Tufte css风格，
(Content centric Hugo blogging theme styled with Tufte-css,)
文件列表:
LICENSE.md (1080, 2023-04-08)
archetypes/ (0, 2023-04-08)
archetypes/page.md (87, 2023-04-08)
archetypes/post.md (83, 2023-04-08)
exampleSite/ (0, 2023-04-08)
exampleSite/config.toml (1466, 2023-04-08)
exampleSite/content/ (0, 2023-04-08)
exampleSite/content/page/ (0, 2023-04-08)
exampleSite/content/page/about.md (114, 2023-04-08)
exampleSite/content/post/ (0, 2023-04-08)
exampleSite/content/post/blockquote.md (857, 2023-04-08)
exampleSite/content/post/new.md (871, 2023-04-08)
exampleSite/content/post/nodate.md (201, 2023-04-08)
exampleSite/content/post/old.md (1040, 2023-04-08)
exampleSite/content/post/tufte-features.md (6264, 2023-04-08)
exampleSite/static/ (0, 2023-04-08)
exampleSite/static/hugo-tufte-override.css (114, 2023-04-08)
images/ (0, 2023-04-08)
images/screenshot.png (281702, 2023-04-08)
images/tn.png (138555, 2023-04-08)
layouts/ (0, 2023-04-08)
layouts/404.html (144, 2023-04-08)
layouts/_default/ (0, 2023-04-08)
layouts/_default/list.html (984, 2023-04-08)
layouts/_default/paginate.list.html (540, 2023-04-08)
layouts/_default/single.html (345, 2023-04-08)
layouts/_default/summary.html (15, 2023-04-08)
layouts/_default/terms.html (1557, 2023-04-08)
layouts/index.html (391, 2023-04-08)
layouts/partials/ (0, 2023-04-08)
layouts/partials/body.includes.html (26, 2023-04-08)
layouts/partials/brand.html (129, 2023-04-08)
layouts/partials/comments.html (0, 2023-04-08)
layouts/partials/content.header.html (1065, 2023-04-08)
layouts/partials/disqus.html (937, 2023-04-08)
layouts/partials/doctype.html (87, 2023-04-08)
layouts/partials/footer.html (684, 2023-04-08)
layouts/partials/header.html (199, 2023-04-08)
layouts/partials/header.includes.html (1311, 2023-04-08)
... ...
# Tufte Hugo Theme
## Maintenance Warning
I do not actively maintain this theme. A fork that now
also apears unmaintained can be found at
https://github.com/slashformotion/hugo-tufte
Hugo-Tufte is a minimalist blog-like theme for the
[static site generator Hugo](https://gohugo.io) that
attempts to be a faithful implementation of the
[Tufte-css](https://github.com/edwardtufte/tufte-css) project.
It supports mathematical typesetting via [MathJax](https://www.mathjax.org).
By utilizing copious partial templates the theme is largely customizable.
## State of Project
This theme is largely unmaintained. If there is a particular fork
that should be considered the primary project please submit a PR
updating the README, thanks!
## Math
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.`
- `A simple displayed equation: $$f(x, y) := e^{x^2 - y^2}.$$`
- `A simple displayed equation: \\[f(x, y) := e^{x^2 - y^2}.\\]`
There currently seems to be some weirdness with other environments,
such as the `align` environment. These environments will render provided
they are wrapped in `
` tags and blank lines. The snippet below should
render correctly.
```
Let $G$ be a finite group with exponent $2$. Then every element is
an involution, hence for any $x$, $y$ in $G$ we have:
\begin{align*}
e &= (xy)^2 \\
&=xyxy \implies \\
y^{-1} &= xyx \implies \\
y^{-1}x^{-1} &= xy,
\end{align*}
establishing that $G$ is abelian.
```
## Site Parameters
The site specific parameters that this theme recognizes are:
- `subtitle` string: This is displayed under the main title.
- `showPoweredBy` boolean: if true, display a shoutout to Hugo and this theme.
- `copyrightHolder` string: Inserts the value in the default copyright notice.
- `copyright` string: Custom copyright notice.
## Page Parameters
- `hideDate` boolean: if true, do not display a page date. When `meta` is set to
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.
- `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.
- `toc` boolean: if true, display the table of contents for the page.
## Shortcodes
This theme provides the following shortcodes in an attempt to completely
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**:
```html
{{% blockquote cite="www.shawnohare.com" footer="Shawn" %}}
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 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
make no styling assumptions, so spacing is important. A more compactly
styled epigraph will be used if the `type` parameter is set to `compact`.
- **Example**:
```
{{% 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: `{{% marginnote %}}...{{% /marginnote %}}`
- **Example**: `{{% marginnote %}}Some marginnote{{% /marginnote%}}`
- `section`
- **Description**: This shortcode is provided as a work-around for wrapping
complex blocks of markdown in section tags. The wrapped text can
include other shortcodes
- **Usage**: Accepts the style parameters `class` and `id`.
If 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`
`{{% sidenote %}}...{{% /sidenote %}}`
- **Example**: `{{% sidenote %}}Some sidenote{{% /sidenote %}}`
## Templates
TODO
- [ ] Describe the role of each template file, as commenting within the files
themselves seems to break the templates.
近期下载者：
相关文件：
收藏者：