Added a routing component

Author: KittyGiraudel

_data/navigation.yml

@@ -1,72 +1,72 @@
 - title: "Getting started"
   items:
     - title: "Command Line"
-      url: "/getting-started/"
+      route: command_line
       _blank: false
     - title: "Configuration"
-      url: "/configuration/"
+      route: configuration
       _blank: false
     - title: "Annotations"
-      url: "/annotations/"
+      route: annotations
       _blank: false
     - title: "File-level annotations"
-      url: "/file-level-annotations/"
+      route: poster_annotations
       _blank: false
     - title: "Customising the view"
-      url: "/customising-the-view/"
+      route: view
       _blank: false
 - title: "Custom theme"
   order: 2
   items:
     - title: "Using your own theme"
-      url: "/using-your-own-theme/"
+      route: custom_theme
       _blank: false
     - title: "Data Interface"
-      url: "/data-interface/"
+      route: data_interface
       _blank: false
     - title: "Extending SassDoc"
-      url: "/extending-sassdoc/"
+      route: extending_sassdoc
       _blank: false
     - title: "Extra tools"
-      url: "/extra-tools/"
+      route: extra_tools
       _blank: false
     - title: "Theme generator"
-      url: "/theme-generator/"
+      route: theme_generator
       _blank: false
     - title: "Theme Gallery"
-      url: "/theme-gallery/"
+      route: theme_gallery
       _blank: false
 - title: "Alternative usages"
   items:
     - title: "Node"
-      url: "/node/"
+      route: node
       _blank: false
     - title: "Grunt"
-      url: "/grunt/"
+      route: grunt
       _blank: false
     - title: "Gulp"
-      url: "/gulp/"
+      route: gulp
       _blank: false
     - title: "Broccoli"
-      url: "/broccoli/"
+      route: broccoli
       _blank: false
 - title: "Extras"
   items:
     - title: "Changelog"
-      url: "/changelog/"
+      route: changelog
       _blank: false
     - title: "About"
-      url: "/about/"
+      route: about
       _blank: false
-    - title: "Frequently Asked questions"
-      url: "/frequently-asked-questions/"
+    - title: "FAQ"
+      route: faq
       _blank: false
     - title: "Contributing"
-      url: "/contributing/"
+      route: contributing
       _blank: false
     - title: "Gallery"
-      url: "/gallery/"
+      route: gallery
       _blank: false
     - title: "Brand guidelines"
-      url: "/brand-guidelines/"
+      route: branding
       _blank: false

_data/routes.yml

@@ -0,0 +1,22 @@
+home: "/"
+command_line: "/getting-started/"
+configuration: "/configuration/"
+annotations: "/annotations/"
+poster_annotations: "/file-level-annotations/"
+view: "/customising-the-view/"
+custom_theme: "/using-your-own-theme/"
+data_interface: "/data-interface/"
+extending_sassdoc: "/extending-sassdoc/"
+extra_tools: "/extra-tools/"
+theme_generator: "/theme-generator/"
+theme_gallery: "/theme-gallery/"
+node: "/node/"
+grunt: "/grunt/"
+gulp: "/gulp/"
+broccoli: "/broccoli/"
+changelog: "/changelog/"
+about: "/about/"
+faq: "/frequently-asked-questions/"
+contributing: "/contributing/"
+gallery: "/gallery/"
+branding: "/brand-guidelines/"

_includes/sidebar.html

@@ -8,9 +8,9 @@ <h2 class="sidebar__title">{{ group.title }}</h2>
 
 <ul class="sidebar__list">
 {% for item in group.items %}
-  {% capture tmp %}{{ item.url }}index.html{% endcapture %}
+  {% capture tmp %}{{ site.data.routes[item.route] }}index.html{% endcapture %}
   <li class="sidebar__list-item  {% if tmp == page.url %}active{% endif %}">
-    <a class="sidebar__link" href="{{ item.url }}" {% if item._blank %}target="_blank"{% endif %}>{{ item.title }}</a>
+    <a class="sidebar__link" href="{{ site.data.routes[item.route] }}" {% if item._blank %}target="_blank"{% endif %}>{{ item.title }}</a>
   </li>
 {% endfor %}
 </ul>

annotations/index.md

@@ -601,4 +601,4 @@ Describes the documented item.
 
 ---
 
-\* The Markdown parsing is effective in compliant themes, by using the Markdown filter from [sassdoc-extras](/extra-tools/#markdown).
+\* The Markdown parsing is effective in compliant themes, by using the Markdown filter from [sassdoc-extras]({{ site.data.routes.extra_tools }}#markdown).

broccoli/index.md

@@ -26,9 +26,9 @@ var docs = sassdoc(tree, options);
 Any specified option will be passed through directly to SassDoc, thus you can
 specify any option that SassDoc supports. Refer to:
 
-* [Getting started](/getting-started/) for CLI options;
-* [Configuration](/configuration/) for SassDoc options;
-* [Customising the view](/customising-the-view/) for default theme options.
+* [Command Line]({{ site.data.routes.command_line }}) for CLI options;
+* [Configuration]({{ site.data.routes.configuration }}) for SassDoc options;
+* [Customising the view]({{ site.data.routes.view }}) for default theme options.
 
 <p class="note note--info">
   <strong>Tip:</strong> provided you know what your doing and you've checked your paths before,

configuration/index.md

@@ -5,7 +5,7 @@ layout: default
 
 ## Introduction
 
-SassDoc comes with surprisingly few configuration in itself. Most of the configuration is [brought by the theme](/customising-the-view). However, you don't have to set up a configuration file in the theme package, that would be silly.
+SassDoc comes with surprisingly few configuration in itself. Most of the configuration is [brought by the theme]({{ site.data.routes.view }}). However, you don't have to set up a configuration file in the theme package, that would be silly.
 
 Here is how it works: SassDoc merge the configuration file you provide (or that is being automatically fetched) with the one from the theme. If an option is set in both files, the one you set yourself overrides the one from the theme.
 
@@ -86,7 +86,7 @@ The `groups` option is an object of aliases for group slugs. When you gather ite
 
 All non-grouped items are gathered by SassDoc in an `undefined` group, that is being aliased as *General*. Feel free to change this to suit your preferences.
 
-<p class="note  note--warning"><strong>Note:</strong> that for this feature to work, <a href="/extra-tools/#groups-aliases">sassdoc-extras</a> has to be used by the theme, which is obviously the case with the default theme.</p>
+<p class="note  note--warning"><strong>Note:</strong> that for this feature to work, <a href="{{ site.data.routes.extra_tools }}#groups-aliases">sassdoc-extras</a> has to be used by the theme, which is obviously the case with the default theme.</p>
 
 ## No update notifier
 

contributing/index.md

@@ -14,7 +14,7 @@ There are many things you can do to contribute SassDoc:
 
 ## Asking a question
 
-Please, do not open an issue only to ask a question; it is not the best place for this. First, make sure your question is not already answered in the documentation, especially in the [Frequently Asked Questions](/frequently-asked-questions/) section.
+Please, do not open an issue only to ask a question; it is not the best place for this. First, make sure your question is not already answered in the documentation, especially in the [Frequently Asked Questions]({{ site.data.routes.faq }}) section.
 
 If it's not, you can leave your question on:
 

customising-the-view/index.md

@@ -5,9 +5,9 @@ title: "Customising the view"
 
 ## Introduction
 
-Aside from regular [configuration](/configuration/) from SassDoc itself, it is likely that the theme you use provides some kind of default configuration that you can overload.
+Aside from regular [configuration]({{ site.data.routes.configuration }}) from SassDoc itself, it is likely that the theme you use provides some kind of default configuration that you can overload.
 
-This is done exactly like the regular configuration, within the same configuration file. Please refer to the [configuration documentation](/configuration/) to learn how to specify a configuration file.
+This is done exactly like the regular configuration, within the same configuration file. Please refer to the [configuration documentation]({{ site.data.routes.configuration }}) to learn how to specify a configuration file.
 
 ## Options
 

extending-sassdoc/index.md

@@ -6,11 +6,11 @@ title: "Extending SassDoc"
 ## Introduction
 
 SassDoc allows you to define custom annotations. This can only be done
-from a [custom theme](/using-your-own-theme/) since there is no way for
+from a [custom theme]({{ site.data.routes.custom_theme }}) since there is no way for
 SassDoc to guess what to do or how those annotations should be displayed.
 
 Here's a simple example to add a few simple annotations to SassDoc
-within your theme. First, you'll have the usual theme function. Refer to [Using Your Own Theme](/using-your-own-theme/) for more informations about this.
+within your theme. First, you'll have the usual theme function. Refer to [Using Your Own Theme]({{ site.data.routes.custom_theme }}) for more informations about this.
 
 {% highlight js %}
 module.exports = function () {
@@ -98,7 +98,5 @@ module.exports.annotations.push({
 });
 {% endhighlight %}
 
-For more examples, you can look at [the core annotations] which are very
+For more examples, you can look at [the core annotations](https://github.com/SassDoc/sassdoc/tree/master/src/annotation/annotations) which are very
 insightful.
-
-[the core annotations]: https://github.com/SassDoc/sassdoc/tree/master/src/annotation/annotations

extra-tools/index.md

@@ -55,7 +55,7 @@ module.exports = function (dest, ctx) {
 
 ## Groups aliases
 
-The `groupName` filter makes it possible for you to define aliases for your group slugs (see [reference](/configuration/#groups)). When using `@group` annotation in your SassDoc comments, you usually define a slug (a lowercase string without spaces). If you want your theme to display pretty titles, you can map those slugs to human-friendly names by setting a `groups` key in your context configuration.
+The `groupName` filter makes it possible for you to define aliases for your group slugs (see [reference]({{ site.data.routes.configuration }}#groups)). When using `@group` annotation in your SassDoc comments, you usually define a slug (a lowercase string without spaces). If you want your theme to display pretty titles, you can map those slugs to human-friendly names by setting a `groups` key in your context configuration.
 
 {% highlight js %}
 {