From e7e3e173c0e05669fc6ed569f9445c126bbb5ee6 Mon Sep 17 00:00:00 2001 From: Adam Date: Mon, 4 Feb 2019 19:58:34 +0100 Subject: [PATCH] Auto-Generated Table of Contents in Sidebar --- _includes/sidebar.html | 108 ++++++++++++------------- _includes/toc.html | 87 ++++++++++++++++++++ index.md | 1 + pages/v2/Choosing-Duality.md | 4 +- pages/v2/List-of-Community-Projects.md | 1 + pages/v2/Requirements.md | 1 + pages/v3/Choosing-Duality.md | 4 +- pages/v3/List-of-Community-Projects.md | 1 + pages/v3/Requirements.md | 1 + 9 files changed, 147 insertions(+), 61 deletions(-) create mode 100644 _includes/toc.html diff --git a/_includes/sidebar.html b/_includes/sidebar.html index bb204d2..3c04b12 100644 --- a/_includes/sidebar.html +++ b/_includes/sidebar.html @@ -6,26 +6,21 @@ {% assign pageUrlWithoutExt = page.url | split: '.html' | first %} {% assign childPages = site.pages | where: 'version', targetVersion | where: 'parent', pageUrlWithoutExt %} {% assign siblingPages = site.pages | where: 'version', targetVersion | where: 'parent', page.parent %} - - + Add Page - - {% if parentPage or childPages.size > 0 %} - {% if parentPage %} - < Go Back - < Go Back - {% else %} - < Go Back + +
+ + {% if parentPage or childPages.size > 0 or page.notoc != true %} + {% if parentPage %} + < Go Back + < Go Back + {% else %} + < Go Back + {% endif %} {% endif %} + + {% if childPages.size > 0 %}

{{ page.title }}

+ + {% elsif page.notoc != true %} +

{{ page.title }}

+ {% include toc.html html=content h_max=3 sanitize=true %} + {% elsif siblingPages.size > 0 %}

{{ parentPage.title }}

+ {% else %} -

{{ page.title }}

+ {% assign sortedPages = site.pages | where: 'version', targetVersion | sort: 'displayOrder' %} + {% for category in site.topLevelCategories %} +

{{ category.title }}

+ + {% endfor %} {% endif %} - - {% else %} - {% assign sortedPages = site.pages | where: 'version', targetVersion | sort: 'displayOrder' %} - {% for category in site.topLevelCategories %} -

{{ category.title }}

+ + {% assign versionPath = page.version | prepend: '/' %} + {% assign urlAfterVersion = page.url | split: versionPath | last %} + {% assign versionPages = "" | split: "" %} + {% for pageItem in site.pages %} + {% assign itemVersionPath = pageItem.version | prepend: '/' %} + {% assign itemUrlAfterVersion = pageItem.url | split: itemVersionPath | last %} + {% if itemUrlAfterVersion == urlAfterVersion %} + {% assign versionPages = versionPages | push: pageItem %} + {% endif %} + {% endfor %} + {% assign sortedVersionPages = versionPages | sort:"version" %} +
+

Versions:

    - {% for pageItem in sortedPages %} - {% if pageItem.category and pageItem.category == category.id %} -
  • - {{ pageItem.title }} - {{ pageItem.title }} -
    • + {% for pageItem in sortedVersionPages %} + {% if pageItem.version == targetVersion %} +
  • {{ pageItem.version }}
    • + {% else %} +
  • {{ pageItem.version }}
    • {% endif %} {% endfor %}
- {% endfor %} - {% endif %} - - {% assign versionPath = page.version | prepend: '/' %} - {% assign urlAfterVersion = page.url | split: versionPath | last %} - {% assign versionPages = "" | split: "" %} - {% for pageItem in site.pages %} - {% assign itemVersionPath = pageItem.version | prepend: '/' %} - {% assign itemUrlAfterVersion = pageItem.url | split: itemVersionPath | last %} - {% if itemUrlAfterVersion == urlAfterVersion %} - {% assign versionPages = versionPages | push: pageItem %} - {% endif %} - {% endfor %} - {% assign sortedVersionPages = versionPages | sort:"version" %} -
-

Versions:

-
    - {% for pageItem in sortedVersionPages %} - {% if pageItem.version == targetVersion %} -
  • {{ pageItem.version }}
    • - {% else %} -
  • {{ pageItem.version }}
    • - {% endif %} - {% endfor %} -
+
\ No newline at end of file diff --git a/_includes/toc.html b/_includes/toc.html new file mode 100644 index 0000000..bb45d1b --- /dev/null +++ b/_includes/toc.html @@ -0,0 +1,87 @@ +{% capture tocWorkspace %} + {% comment %} + Version 1.0.6 + 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 + + 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 minHeader = include.h_min | default: 1 %} + {% assign maxHeader = include.h_max | default: 6 %} + {% assign nodes = include.html | split: ' maxHeader %} + {% continue %} + {% endif %} + + {% if firstHeader %} + {% assign firstHeader = false %} + {% assign minHeader = headerLevel %} + {% endif %} + + {% assign indentAmount = headerLevel | minus: minHeader | add: 1 %} + {% assign _workspace = node | split: '' | first }}>{% endcapture %} + {% assign header = _workspace[0] | replace: _hAttrToStrip, '' %} + + {% assign space = '' %} + {% for i in (1..indentAmount) %} + {% assign space = space | prepend: ' ' %} + {% endfor %} + + {% unless include.item_class == blank %} + {% capture listItemClass %}{:.{{ include.item_class | replace: '%level%', headerLevel }}}{% endcapture %} + {% endunless %} + + {% capture my_toc %}{{ my_toc }} +{{ space }}{{ listModifier }} {{ listItemClass }} [{% if include.sanitize %}{{ header | strip_html }}{% else %}{{ header }}{% endif %}]({% if include.baseurl %}{{ include.baseurl }}{% endif %}#{{ html_id }}){% if include.anchor_class %}{:.{{ include.anchor_class }}}{% endif %}{% endcapture %} + {% endfor %} + + {% if include.class %} + {% capture my_toc %}{:.{{ include.class }}} +{{ my_toc | lstrip }}{% endcapture %} + {% endif %} + + {% if include.id %} + {% capture my_toc %}{: #{{ include.id }}} +{{ my_toc | lstrip }}{% endcapture %} + {% endif %} +{% endcapture %}{% assign tocWorkspace = '' %}{{ my_toc | markdownify | strip }} \ No newline at end of file diff --git a/index.md b/index.md index 51ced59..0d73b5b 100644 --- a/index.md +++ b/index.md @@ -3,6 +3,7 @@ title: "Home" category: "introduction" displayOrder: -100 version: "v3" +notoc: true --- Welcome to the Duality docs pages! If you're looking for a **developer manual**, check the side bar to your left. diff --git a/pages/v2/Choosing-Duality.md b/pages/v2/Choosing-Duality.md index 416cd6c..3f7657e 100644 --- a/pages/v2/Choosing-Duality.md +++ b/pages/v2/Choosing-Duality.md @@ -3,15 +3,13 @@ title: "Should You Use Duality?" category: "introduction" displayOrder: 10 version: "v2" +notoc: true --- Someone once said: "Every game engine sucks - but each in its own, unique way". Choosing an engine is not about going through a shopping list of billboard features, it's not even about deciding which one is "better". It's about setting priorities and identifying requirements: What does your game need, and what do _you_ need, as a developer? What do you value? This guide is here to help you decide whether your next project should be made with Duality. _If you haven't read the info page yet, [head over here](https://www.duality2d.net) first._ -* TOC -{:toc} - # About Duality So let's take a close, honest look. If you're with us by the end of this chapter, Duality and you have a solid chance. diff --git a/pages/v2/List-of-Community-Projects.md b/pages/v2/List-of-Community-Projects.md index f4ff6fb..79e5e9f 100644 --- a/pages/v2/List-of-Community-Projects.md +++ b/pages/v2/List-of-Community-Projects.md @@ -3,6 +3,7 @@ title: "List of Community Projects" category: "development" displayOrder: 0 version: "v2" +notoc: true --- The following is a list of projects that are maintained and published by the community. Feel free to add your own if you think that it could be useful to others! diff --git a/pages/v2/Requirements.md b/pages/v2/Requirements.md index d162674..7d5083b 100644 --- a/pages/v2/Requirements.md +++ b/pages/v2/Requirements.md @@ -3,6 +3,7 @@ title: "Requirements" category: "introduction" displayOrder: 0 version: "v2" +notoc: true --- To launch a Duality application, the end user needs the [.Net Framework 4.5](https://www.google.de/#hl=en&q=.net+framework+4.5) on Windows machines, or the equivalent [Mono](http://www.mono-project.com/) version on non-Windows machines. The actual hardware minimum to launch a Duality application depends on the application itself. diff --git a/pages/v3/Choosing-Duality.md b/pages/v3/Choosing-Duality.md index abb724b..a672fe3 100644 --- a/pages/v3/Choosing-Duality.md +++ b/pages/v3/Choosing-Duality.md @@ -3,15 +3,13 @@ title: "Should You Use Duality?" category: "introduction" displayOrder: 10 version: "v3" +notoc: true --- Someone once said: "Every game engine sucks - but each in its own, unique way". Choosing an engine is not about going through a shopping list of billboard features, it's not even about deciding which one is "better". It's about setting priorities and identifying requirements: What does your game need, and what do _you_ need, as a developer? What do you value? This guide is here to help you decide whether your next project should be made with Duality. _If you haven't read the info page yet, [head over here](https://www.duality2d.net) first._ -* TOC -{:toc} - # About Duality So let's take a close, honest look. If you're with us by the end of this chapter, Duality and you have a solid chance. diff --git a/pages/v3/List-of-Community-Projects.md b/pages/v3/List-of-Community-Projects.md index 2b79ce9..1fa64a2 100644 --- a/pages/v3/List-of-Community-Projects.md +++ b/pages/v3/List-of-Community-Projects.md @@ -3,6 +3,7 @@ title: "List of Community Projects" category: "development" displayOrder: 0 version: "v3" +notoc: true --- The following is a list of projects that are maintained and published by the community. Feel free to add your own if you think that it could be useful to others! diff --git a/pages/v3/Requirements.md b/pages/v3/Requirements.md index 190b074..d3b0f66 100644 --- a/pages/v3/Requirements.md +++ b/pages/v3/Requirements.md @@ -3,6 +3,7 @@ title: "Requirements" category: "introduction" displayOrder: 0 version: "v3" +notoc: true --- To launch a Duality application, the end user needs the [.Net Framework 4.5](https://www.google.de/#hl=en&q=.net+framework+4.5) on Windows machines, or the equivalent [Mono](http://www.mono-project.com/) version on non-Windows machines. The actual hardware minimum to launch a Duality application depends on the application itself, but graphics support for OpenGL 3.0 or OpenGL ES 2.0 is a common baseline.