Skip to content

Commit a6b7763

Browse files
committed
Merge branch 'master' of github.com:jsdoc3/jsdoc3.github.com
2 parents de7d500 + a8a00b9 commit a6b7763

File tree

3 files changed

+16
-10
lines changed

3 files changed

+16
-10
lines changed

about-tutorials.html

+5-3
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,9 @@ <h2 id="adding-tutorials">Adding tutorials</h2>
6363
</ul>
6464
<p>JSDoc also searches for JSON files that contain information about the titles, ordering, and hierarchy of your tutorials, as discussed in the following section.</p>
6565
<p>JSDoc assigns an identifier to each tutorial. The identifier is the filename without its extension. For example, the identifier for <code>/path/to/tutorials/overview.md</code> is <code>overview</code>.</p>
66-
<p>In tutorial files, you can use the <a href="tags-inline-link.html"><code>{@link}</code></a> and <a href="tags-inline-tutorial.html"><code>{@tutorial}</code></a> inline tags to link to other parts of the documentation. JSDoc will automatically resolve the links.</p>
66+
<p>In tutorial files, you can use the <a href="tags-inline-link.html"><code>{@link}</code></a> and
67+
<a href="tags-inline-tutorial.html"><code>{@tutorial}</code></a> inline tags to link to other parts of the documentation. JSDoc will automatically resolve
68+
the links.</p>
6769
<h2 id="configuring-titles-order-and-hierarchy">Configuring titles, order, and hierarchy</h2>
6870
<p>By default, JSDoc uses the filename as the tutorial&#39;s title, and all tutorials are at the same level. You can use a JSON file to provide a title for each
6971
tutorial and indicates how the tutorials should be sorted and grouped in the documentation.</p>
@@ -121,8 +123,8 @@ <h2 id="configuring-titles-order-and-hierarchy">Configuring titles, order, and h
121123
<h2 id="linking-to-tutorials-from-api-documentation">Linking to tutorials from API documentation</h2>
122124
<p>There are multiple ways to link to a tutorial from your API documentation:</p>
123125
<h3 id="-tutorial-block-tag">@tutorial block tag</h3>
124-
<p>If you include a <a href="tags-inline-tutorial.html"><code>@tutorial</code> block tag</a> in a JSDoc comment, the generated documentation will include a link
125-
to the tutorial you specify.</p>
126+
<p>If you include a <a href="tags-tutorial.html"><code>@tutorial</code> block tag</a> in a JSDoc comment, the generated documentation will include a link to the
127+
tutorial you specify.</p>
126128
<figure>
127129
<figcaption>Using the <code>@tutorial</code> block tag</figcaption><pre class="prettyprint lang-js"><code>/**
128130
* Class representing a socket connection.

content/en/about-tutorials.md

+10-6
Original file line numberDiff line numberDiff line change
@@ -30,11 +30,12 @@ hierarchy of your tutorials, as discussed in the following section.
3030
JSDoc assigns an identifier to each tutorial. The identifier is the filename without its extension.
3131
For example, the identifier for `/path/to/tutorials/overview.md` is `overview`.
3232

33-
In tutorial files, you can use the [`{@link}`][link-tag] and [`{@tutorial}`][tutorial-tag] inline
34-
tags to link to other parts of the documentation. JSDoc will automatically resolve the links.
33+
In tutorial files, you can use the [`{@link}`][link-inline-tag] and
34+
[`{@tutorial}`][tutorial-inline-tag] inline tags to link to other parts of the documentation. JSDoc
35+
will automatically resolve the links.
3536

36-
[link-tag]: tags-inline-link.html
37-
[tutorial-tag]: tags-inline-tutorial.html
37+
[link-inline-tag]: tags-inline-link.html
38+
[tutorial-inline-tag]: tags-inline-tutorial.html
3839

3940

4041
## Configuring titles, order, and hierarchy
@@ -106,7 +107,7 @@ There are multiple ways to link to a tutorial from your API documentation:
106107

107108
### @tutorial block tag
108109

109-
If you include a [`@tutorial` block tag][tutorial-tag] in a JSDoc comment, the generated documentation
110+
If you include a [`@tutorial` block tag][tutorial-block-tag] in a JSDoc comment, the generated documentation
110111
will include a link to the tutorial you specify.
111112

112113
{% example "Using the `@tutorial` block tag" %}
@@ -125,7 +126,7 @@ function Socket() {}
125126

126127
### {@tutorial} inline tag
127128

128-
You can also use the [`{@tutorial}` inline tag][tutorial-tag] to link to a tutorial within the text
129+
You can also use the [`{@tutorial}` inline tag][tutorial-inline-tag] to link to a tutorial within the text
129130
of another tag. By default, JSDoc will use the tutorial's title as the link text.
130131

131132
{% example "Using the `{@tutorial}` inline tag" %}
@@ -140,3 +141,6 @@ of another tag. By default, JSDoc will use the tutorial's title as the link text
140141
function Socket() {}
141142
```
142143
{% endexample %}
144+
145+
[tutorial-block-tag]: tags-tutorial.html
146+
[tutorial-inline-tag]: tags-inline-tutorial.html

styles/usejsdoc.css

+1-1
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ ol, ul {
106106
}
107107

108108
code {
109-
font: 1em Consolas, "Lucida Console", Monaco, monospace;
109+
font: 0.9em Consolas, "Lucida Console", Monaco, monospace;
110110
background-color: #DEDEDE;
111111
}
112112

0 commit comments

Comments
 (0)