diff --git a/docs/_data/nav.yml b/docs/_data/nav.yml index b70afe93..a24cd79f 100644 --- a/docs/_data/nav.yml +++ b/docs/_data/nav.yml @@ -11,16 +11,16 @@ sidebar: - title: Node app projects section: node url: /app/node/ -# subnav: -# - title: Getting started -# url: /app/node/getting_started.html -# - title: Command reference -# url: /app/node/commands.html + subnav: + - title: Getting started + url: /app/node/ + - title: Command reference + url: /app/node/commands/ - title: Rails app projects section: rails url: /app/rails/ -# subnav: -# - title: Getting started -# url: /app/rails/getting_started.html -# - title: Command reference -# url: /app/rails/commands.html + subnav: + - title: Getting started + url: /app/rails/ + - title: Command reference + url: /app/rails/commands/ diff --git a/docs/_includes/head.html b/docs/_includes/head.html index ba953215..75493f2e 100644 --- a/docs/_includes/head.html +++ b/docs/_includes/head.html @@ -14,6 +14,6 @@ - + diff --git a/docs/_includes/sidebar_nav.html b/docs/_includes/sidebar_nav.html index 6c785549..e868d839 100644 --- a/docs/_includes/sidebar_nav.html +++ b/docs/_includes/sidebar_nav.html @@ -1,19 +1,22 @@
- + + + diff --git a/docs/_includes/toc.html b/docs/_includes/toc.html new file mode 100644 index 00000000..6971739f --- /dev/null +++ b/docs/_includes/toc.html @@ -0,0 +1,112 @@ +{% capture tocWorkspace %} + {% comment %} + Version 1.0.11 + https://github.com/allejo/jekyll-toc + + "...like all things liquid - where there's a will, and ~36 hours to spare, there's usually a/some way" ~jaybe + + Usage: + {% include toc.html html=content sanitize=true class="inline_toc" id="my_toc" h_min=2 h_max=3 %} + + Parameters: + * html (string) - the HTML of compiled markdown generated by kramdown in Jekyll + + Optional Parameters: + * sanitize (bool) : false - when set to true, the headers will be stripped of any HTML in the TOC + * class (string) : '' - a CSS class assigned to the TOC + * id (string) : '' - an ID to assigned to the TOC + * h_min (int) : 1 - the minimum TOC header level to use; any header lower than this value will be ignored + * h_max (int) : 6 - the maximum TOC header level to use; any header greater than this value will be ignored + * ordered (bool) : false - when set to true, an ordered list will be outputted instead of an unordered list + * item_class (string) : '' - add custom class(es) for each list item; has support for '%level%' placeholder, which is the current heading level + * baseurl (string) : '' - add a base url to the TOC links for when your TOC is on another page than the actual content + * anchor_class (string) : '' - add custom class(es) for each anchor element + * skipNoIDs (bool) : false - skip headers that do not have an `id` attribute + + Output: + An ordered or unordered list representing the table of contents of a markdown block. This snippet will only + generate the table of contents and will NOT output the markdown given to it + {% endcomment %} + + {% capture my_toc %}{% endcapture %} + {% assign orderedList = include.ordered | default: false %} + {% assign skipNoIDs = include.skipNoIDs | default: false %} + {% assign minHeader = include.h_min | default: 1 %} + {% assign maxHeader = include.h_max | default: 6 %} + {% assign nodes = include.html | split: '