Skip to content

Commit

Permalink
Improve table of contents
Browse files Browse the repository at this point in the history
- Replace html snippet with _includes/toc.html
- Add FA icon to table of contents header
- Display table of contents on small screens
- Add hierarchy to toc with indents
  • Loading branch information
mmistakes committed Jan 21, 2015
1 parent 3688b97 commit 9a1c5ff
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 26 deletions.
9 changes: 9 additions & 0 deletions _includes/_toc.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<section id="table-of-contents" class="toc">
<header>
<h3><i class="fa fa-book"></i> Overview</h3>
</header>
<div id="drawer" markdown="1">
* Auto generated table of contents
{:toc}
</div>
</section><!-- /#table-of-contents -->
8 changes: 5 additions & 3 deletions _sass/page.scss
Original file line number Diff line number Diff line change
Expand Up @@ -450,9 +450,8 @@ $button-size: 1.5rem;

/* Table of contents */
.toc {
display: none;
font-size: 95%;
@media #{$small} {
@media #{$large} {
display: block;
@include grid(12,2);
@include prefix(12,0.5);
Expand Down Expand Up @@ -503,13 +502,16 @@ $button-size: 1.5rem;
}
ul {
margin: 1px 0 0;
li a {
padding-left: 20px;
}
}
}
}

/* TOC trigger for collapsing */
#drawer {
height: 100%;
max-height: 100%;
overflow: hidden;
&.js-hidden {
max-height: 0;
Expand Down
27 changes: 4 additions & 23 deletions theme-setup/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,7 @@ image:
creditlink: http://wegraphics.net/downloads/free-ultimate-blurred-background-pack/
---

<section id="table-of-contents" class="toc">
<header>
<h3>Overview</h3>
</header>
<div id="drawer" markdown="1">
* Auto generated table of contents
{:toc}
</div>
</section><!-- /#table-of-contents -->
{% include _toc.html %}

## Installation

Expand Down Expand Up @@ -268,23 +260,12 @@ To assign Billy Rick as an author for our post. We'd add the following YAML fron
author: billy_rick
{% endhighlight %}

### Table of Contents
### Kramdown Table of Contents

Any post or page that you want a *table of contents* to render insert the following HTML in your post before the actual content. [Kramdown will take care of the rest](http://kramdown.rubyforge.org/converter/html.html#toc) and convert all headlines into a contents list.

**PS:** The TOC is hidden on small devices because I haven't gotten around to optimizing it. For now it only appears on larger screens (tablet and desktop).
{: .notice}
To include an auto-generated **table of contents** for posts and pages, add the following `_include` before the actual content. [Kramdown will take care of the rest](http://kramdown.rubyforge.org/converter/html.html#toc) and convert all headlines into list of links.

{% highlight html %}
<section id="table-of-contents" class="toc">
<header>
<h3>Overview</h3>
</header>
<div id="drawer" markdown="1">
* Auto generated table of contents
{:toc}
</div>
</section><!-- /#table-of-contents -->
{% raw %}{% include _toc.html %}{% endraw %}
{% endhighlight %}

### Paragraph Indentation
Expand Down

0 comments on commit 9a1c5ff

Please sign in to comment.