Skip to content

Commit 35fba7b

Browse files
committed
Simplified the routing system by adding a partial generating Markdown references
1 parent 7992d3f commit 35fba7b

File tree

21 files changed

+69
-29
lines changed

21 files changed

+69
-29
lines changed

_includes/routes.html

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{% for route in site.data.routes %}
2+
[{{ route[0] }}]: {{ route[1] }}
3+
{% endfor %}

about/index.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ There is nothing new with SassDoc. It has nothing of a revolutionnary idea; ther
99

1010
Still, we needed this. We needed a way to document our Sass files, APIs, frameworks, libraries and whatever. Thus, this project.
1111

12-
SassDoc is built by [Pascal Duez](https://twitter.com/pascalduez), [Valerian Galliat](https://twitter.com/valeriangalliat), [Hugo Giraudel](https://twitter.com/hugogiraudel) and [Fabrice Weinberg](https://twitter.com/fweinb), a.k.a [SassDoc team](https://github.com/sassdoc) with the help of [Why Alix](https://twitter.com/isendil) for the design. And perhaps you, if you feel like <a href="/contributing/">contributing</a>!
12+
SassDoc is built by [Pascal Duez](https://twitter.com/pascalduez), [Valerian Galliat](https://twitter.com/valeriangalliat), [Hugo Giraudel](https://twitter.com/hugogiraudel) and [Fabrice Weinberg](https://twitter.com/fweinb), a.k.a [SassDoc team](https://github.com/sassdoc) with the help of [Why Alix](https://twitter.com/isendil) for the design. And perhaps you, if you feel like <a href="{{ site.data.routes.contributing }}">contributing</a>!
1313

1414
<ul class="authors">
1515
<li class="author">
@@ -48,3 +48,5 @@ SassDoc is built by [Pascal Duez](https://twitter.com/pascalduez), [Valerian Gal
4848
<span class="author__role">Contributor</span>
4949
</li>
5050
</ul>
51+
52+
{% include routes.html %}

annotations/index.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -602,3 +602,5 @@ Describes the documented item.
602602
---
603603

604604
\* The Markdown parsing is effective in compliant themes, by using the Markdown filter from [sassdoc-extras]({{ site.data.routes.extra_tools }}#markdown).
605+
606+
{% include routes.html %}

brand-guidelines/index.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,3 +53,5 @@ $code-font-stack: 'Courier New', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono',
5353
## Illustration
5454

5555
![PNG Logo](/assets/images/illustration.png)
56+
57+
{% include routes.html %}

broccoli/index.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,9 @@ var docs = sassdoc(tree, options);
2626
Any specified option will be passed through directly to SassDoc, thus you can
2727
specify any option that SassDoc supports. Refer to:
2828

29-
* [Command Line]({{ site.data.routes.command_line }}) for CLI options;
30-
* [Configuration]({{ site.data.routes.configuration }}) for SassDoc options;
31-
* [Customising the view]({{ site.data.routes.view }}) for default theme options.
29+
* [Command Line][command_line] for CLI options;
30+
* [Configuration][configuration] for SassDoc options;
31+
* [Customising the view][view] for default theme options.
3232

3333
<p class="note note--info">
3434
<strong>Tip:</strong> provided you know what your doing and you've checked your paths before,
@@ -69,3 +69,5 @@ var docs = sassdoc('path/to/sass', {
6969
'package': './package.json'
7070
});
7171
{% endhighlight %}
72+
73+
{% include routes.html %}

configuration/index.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ layout: default
55

66
## Introduction
77

8-
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.
8+
SassDoc comes with surprisingly few configuration in itself. Most of the configuration is [brought by the theme][view]. However, you don't have to set up a configuration file in the theme package, that would be silly.
99

1010
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.
1111

@@ -93,3 +93,5 @@ All non-grouped items are gathered by SassDoc in an `undefined` group, that is b
9393
SassDoc tries to make sure you always use an up-to-date version. If it is not the case, it will prompt you to update your current version. You can disable this behaviour by using the `no-update-notifier` option.
9494

9595
<p class="note note--info"><strong>Note:</strong> you can also use the CLI option <code>--no-update-notifier</code>.</p>
96+
97+
{% include routes.html %}

contributing/index.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ There are many things you can do to contribute SassDoc:
1414

1515
## Asking a question
1616

17-
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.
17+
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][faq] section.
1818

1919
If it's not, you can leave your question on:
2020

@@ -54,3 +54,5 @@ If you are thinking of something a bit more complex, be sure to talk with someon
5454
New features or sizeable refactors should be based on the `develop` branch while bugfixes should head into both `master` and `develop`.
5555

5656
Anyway, thank you very much for contributing!
57+
58+
{% include routes.html %}

customising-the-view/index.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ title: "Customising the view"
55

66
## Introduction
77

8-
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.
8+
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.
99

10-
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.
10+
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.
1111

1212
## Options
1313

@@ -146,3 +146,5 @@ googleAnalytics: 'UA-XXXXX-YY'
146146
tracking: |
147147
<img src="http://piwik.example.org/piwik.php?idsite={$IDSITE}amp;rec=1" style="border:0" alt="" />
148148
{% endhighlight %}
149+
150+
{% include routes.html %}

data-interface/index.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -421,3 +421,5 @@ An item will look like this:
421421
/* ... */
422422
}
423423
{% endhighlight %}
424+
425+
{% include routes.html %}

extending-sassdoc/index.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@ title: "Extending SassDoc"
66
## Introduction
77

88
SassDoc allows you to define custom annotations. This can only be done
9-
from a [custom theme]({{ site.data.routes.custom_theme }}) since there is no way for
9+
from a [custom theme][custom_theme] since there is no way for
1010
SassDoc to guess what to do or how those annotations should be displayed.
1111

1212
Here's a simple example to add a few simple annotations to SassDoc
13-
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.
13+
within your theme. First, you'll have the usual theme function. Refer to [Using Your Own Theme][custom_theme] for more informations about this.
1414

1515
{% highlight js %}
1616
module.exports = function () {
@@ -100,3 +100,5 @@ module.exports.annotations.push({
100100

101101
For more examples, you can look at [the core annotations](https://github.com/SassDoc/sassdoc/tree/master/src/annotation/annotations) which are very
102102
insightful.
103+
104+
{% include routes.html %}

0 commit comments

Comments
 (0)