Skip to content

Commit

Permalink
support table of contents for Markdown posts
Browse files Browse the repository at this point in the history
  • Loading branch information
yihui committed Feb 5, 2024
1 parent d776326 commit 9b0a76e
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 0 deletions.
1 change: 1 addition & 0 deletions exampleSite/content/about.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: About Hugo XMin
author: Yihui Xie
toc: true
---

**XMin** is the first Hugo theme I have designed. The original reason that I wrote it was I needed a minimal example of Hugo themes when I was writing the [**blogdown**](https://github.com/rstudio/blogdown) book. Basically I wanted a simple theme that supports a navigation menu, a home page, other single pages, lists of pages, blog posts, categories, tags, and RSS. That is all. Nothing fancy. In terms of CSS and JavaScript, I really want to keep them minimal. In fact, this theme does not contain any JavaScript code at all, although on this example website I did introduce some JavaScript code (still relatively simple anyway). The theme does not contain any images, either, and is pretty much a plain-text theme.
Expand Down
4 changes: 4 additions & 0 deletions layouts/_default/single.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@ <h1><span class="title">{{ .Title | markdownify }}</span></h1>
{{ if (gt .Params.date 0) }}<h2 class="date">{{ .Date.Format "2006/01/02" }}</h2>{{ end }}
</div>

{{ if .Params.toc }}
{{ .TableOfContents }}
{{ end }}

<main>
{{ .Content }}
</main>
Expand Down
4 changes: 4 additions & 0 deletions static/css/style.css
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,10 @@ hr {
border-style: dashed;
color: #ddd;
}
#TableOfContents, #TOC {
border: 1px solid #eee;
border-radius: 5px;
}

/* code */
pre {
Expand Down

0 comments on commit 9b0a76e

Please sign in to comment.