Toggle table of contents via front matter (#1310)
* Add jekyll-toc include * Reduce whitespace generated by comments * Add table of contents include to `single` layout * Replace `toc` include with jekyll-toc enabled YAML Front Matter * Update README * Update table of contents documentation - Revise `toc` helper include to mention that it will be deprecated in the next major version. - Add documentation to `single` layout explaining how to enable table of contents on those pages. * Update CHANGELOG and history * Update LICENSE Close #1222
This commit is contained in:
Michael Rose
@@ -1,100 +0,0 @@
|
||||
---
|
||||
title: "Layout: Post with Table Of Contents Included at Bottom"
|
||||
header:
|
||||
image: assets/images/unsplash-image-9.jpg
|
||||
caption: "Photo credit: [**Unsplash**](https://unsplash.com)"
|
||||
tags:
|
||||
- table of contents
|
||||
---
|
||||
|
||||
Testing Kramdown auto-generated table of contents included near the end of post content. If positioned correctly with CSS, it should appear in aligned (and to the right) of the main content.
|
||||
|
||||
```liquid
|
||||
{% raw %}{% include toc title="Unique Title" icon="file-text" %}{% endraw %}
|
||||
```
|
||||
|
||||
## HTML Elements
|
||||
|
||||
Below is just about everything you'll need to style in the theme. Check the source code to see the many embedded elements within paragraphs.
|
||||
|
||||
<h1>Heading 1</h1>
|
||||
<h2>Heading 2</h2>
|
||||
<h3>Heading 3</h3>
|
||||
<h4>Heading 4</h4>
|
||||
<h5>Heading 5</h5>
|
||||
<h6>Heading 6</h6>
|
||||
|
||||
## Body text
|
||||
|
||||
Lorem ipsum dolor sit amet, test link adipiscing elit. **This is strong**. Nullam dignissim convallis est. Quisque aliquam.
|
||||
|
||||
|
||||
{: .image-right}
|
||||
|
||||
*This is emphasized*. Donec faucibus. Nunc iaculis suscipit dui. 53 = 125. Water is H2O. Nam sit amet sem. Aliquam libero nisi, imperdiet at, tincidunt nec, gravida vehicula, nisl. The New York Times (That’s a citation). Underline.Maecenas ornare tortor. Donec sed tellus eget sapien fringilla nonummy. Mauris a ante. Suspendisse quam sem, consequat at, commodo vitae, feugiat in, nunc. Morbi imperdiet augue quis tellus.
|
||||
|
||||
HTML and CSS are our tools. Mauris a ante. Suspendisse quam sem, consequat at, commodo vitae, feugiat in, nunc. Morbi imperdiet augue quis tellus. Praesent mattis, massa quis luctus fermentum, turpis mi volutpat justo, eu volutpat enim diam eget metus.
|
||||
|
||||
### Blockquotes
|
||||
|
||||
> Lorem ipsum dolor sit amet, test link adipiscing elit. Nullam dignissim convallis est. Quisque aliquam.
|
||||
|
||||
## List Types
|
||||
|
||||
### Ordered Lists
|
||||
|
||||
1. Item one
|
||||
1. sub item one
|
||||
2. sub item two
|
||||
3. sub item three
|
||||
2. Item two
|
||||
|
||||
### Unordered Lists
|
||||
|
||||
* Item one
|
||||
* Item two
|
||||
* Item three
|
||||
|
||||
## Tables
|
||||
|
||||
| Header1 | Header2 | Header3 |
|
||||
|:--------|:-------:|--------:|
|
||||
| cell1 | cell2 | cell3 |
|
||||
| cell4 | cell5 | cell6 |
|
||||
|----
|
||||
| cell1 | cell2 | cell3 |
|
||||
| cell4 | cell5 | cell6 |
|
||||
|=====
|
||||
| Foot1 | Foot2 | Foot3
|
||||
{: rules="groups"}
|
||||
|
||||
## Code Snippets
|
||||
|
||||
```css
|
||||
#container {
|
||||
float: left;
|
||||
margin: 0 -240px 0 0;
|
||||
width: 100%;
|
||||
}
|
||||
```
|
||||
|
||||
## Buttons
|
||||
|
||||
Make any link standout more when applying the `.btn` class.
|
||||
|
||||
```html
|
||||
<a href="#" class="btn btn-success">Success Button</a>
|
||||
```
|
||||
|
||||
<div markdown="0"><a href="#" class="btn">Primary Button</a></div>
|
||||
<div markdown="0"><a href="#" class="btn btn--success">Success Button</a></div>
|
||||
<div markdown="0"><a href="#" class="btn btn--warning">Warning Button</a></div>
|
||||
<div markdown="0"><a href="#" class="btn btn--danger">Danger Button</a></div>
|
||||
<div markdown="0"><a href="#" class="btn btn--info">Info Button</a></div>
|
||||
|
||||
## Notices
|
||||
|
||||
**Watch out!** You can also add notices by appending `{: .notice}` to a paragraph.
|
||||
{: .notice}
|
||||
|
||||
{% include toc title="Unique Title" icon="file-text" %}
|
||||
@@ -5,27 +5,25 @@ header:
|
||||
caption: "Photo credit: [**Unsplash**](https://unsplash.com)"
|
||||
tags:
|
||||
- table of contents
|
||||
toc: true
|
||||
toc_label: "Unique Title"
|
||||
toc_icon: "heart"
|
||||
---
|
||||
|
||||
{% include toc title="Unique Title" icon="file-text" %}
|
||||
Enable table of contents on post or page by adding `toc: true` to its YAML Front Matter. The title and icon can also be changed with:
|
||||
|
||||
Testing Kramdown auto-generated table of contents with unique title and icon assigned in the include like so:
|
||||
|
||||
```liquid
|
||||
{% raw %}{% include toc title="Unique Title" icon="file-text" %}{% endraw %}
|
||||
```yaml
|
||||
---
|
||||
toc: true
|
||||
toc_label: "Unique Title"
|
||||
toc_icon: "heart" # corresponding Font Awesome icon name (without fa prefix)
|
||||
---
|
||||
```
|
||||
|
||||
## HTML Elements
|
||||
|
||||
Below is just about everything you'll need to style in the theme. Check the source code to see the many embedded elements within paragraphs.
|
||||
|
||||
<h1>Heading 1</h1>
|
||||
<h2>Heading 2</h2>
|
||||
<h3>Heading 3</h3>
|
||||
<h4>Heading 4</h4>
|
||||
<h5>Heading 5</h5>
|
||||
<h6>Heading 6</h6>
|
||||
|
||||
## Body text
|
||||
|
||||
Lorem ipsum dolor sit amet, test link adipiscing elit. **This is strong**. Nullam dignissim convallis est. Quisque aliquam.
|
||||
|
||||
@@ -10,12 +10,11 @@ tags:
|
||||
- formatting
|
||||
- html
|
||||
- markup
|
||||
toc: true
|
||||
---
|
||||
|
||||
A variety of common markup showing how the theme styles them.
|
||||
|
||||
# Header one
|
||||
|
||||
## Header two
|
||||
|
||||
### Header three
|
||||
|
||||
@@ -1,12 +1,13 @@
|
||||
---
|
||||
title: "Markup: Syntax Highlighting"
|
||||
excerpt: "Post displaying the various ways of highlighting code in Markdown."
|
||||
last_modified_at: 2016-09-09T09:55:10-04:00
|
||||
last_modified_at: 2017-10-20T12:23:00-04:00
|
||||
header:
|
||||
teaser: "assets/images/markup-syntax-highlighting-teaser.jpg"
|
||||
tags:
|
||||
- code
|
||||
- syntax highlighting
|
||||
toc: true
|
||||
---
|
||||
|
||||
Syntax highlighting is a feature that displays source code, in different colors and fonts according to the category of terms. This feature facilitates writing in a structured language such as a programming language or a markup language as both structures and syntax errors are visually distinct. Highlighting does not affect the meaning of the text itself; it is intended only for human readers.[^1]
|
||||
|
||||
Reference in New Issue
Block a user