github/hugo
1
0
Fork 0
mirror of https://github.com/gohugoio/hugo.git synced 2024-11-21 20:46:30 -05:00
Code Issues Projects Releases Packages Wiki Activity

docs: Remove the source relative links docs

Browse source 
See #3028
This commit is contained in:
Bjørn Erik Pedersen 2017-02-11 20:56:46 +07:00
parent 2ded3bf30f
commit a988d3cf36
1 changed files with 1 additions and 50 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

51
docs/content/overview/configuration.md
View file

@ -413,56 +413,7 @@ paired with the corresponding flags from Blackfriday's source code (for the latt
</small>
</td>
</tr>
<tr>
<td><code><strong>sourceRelativeLinksEval</strong></code></td>
<td><code>false</code></td>
<td><code>none</code></td>
</tr>
<tr>
<td class="purpose-description" colspan="3">
<span class="purpose-title">Purpose:</span>
<code>true</code> enables source file-based relative linking (à la Github).
Relative links to Markdown and static files within a page
will be evaluated relative to the location of that page,
and then converted to HTML links during rendering.<br>
<small>
<strong>Example:</strong>
<code>[some-reference-text](../other/page.md)</code> in
<code>./content/total/overview.md</code> will link to
<code>./content/other/overview.md</code> and render to
<code>/other/overview/</code> in the HTML output.
</small>
</td>
</tr>
<tr>
<td><code><strong>sourceRelativeLinksProjectFolder</strong></code></td>
<td><code>/docs/content</code></td>
<td><code>none</code></td>
</tr>
<tr>
<td class="purpose-description" colspan="3">
<span class="purpose-title">Purpose:</span>
Set a sub-folder for source file-based relative linking
on a Hugo Project (i.e., a web site). When
<code>sourceRelativeLinksEval</code> (see above) is enabled,
some source level paths may contain absolute respository
paths to Markdown or static files.
The absolute portion of these paths should be removed
before trying to match the intended links.<br />
<small>
<strong>Example:</strong>
Assuming your documentation resides in
<code>./docs/content</code>,
then a reference within
<code>./docs/content/total/overview.md</code> to
<code>[some-reference-text](/docs/content/other/page.md)</code>
will link to
<code>./docs/content/other/overview.md</code> and render to
<code>/other/overview/</code> in the HTML output.
</small>
</td>
</tr>
</tbody>
</tbody>
</table>
**Notes**