diff --git a/content/overview/configuration.md b/content/overview/configuration.md index e351c651a..9d721d4a0 100644 --- a/content/overview/configuration.md +++ b/content/overview/configuration.md @@ -289,6 +289,38 @@ Its behavior can be modified with the latexDashes flag listed below Extensions in this option won't be loaded.
Example: Add "autoHeaderIds" to disable EXTENSION_AUTO_HEADER_IDS. + + +sourceRelativeLinksEval +false +none + + +Purpose: +Source file based relative linking (a 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. For example, +`[example](../other/page.md)` in `content/total/overview.md` will be linked to +`content/other/overview.md`, and then rendered to `/other/overview/` in the HTML output. + + + + +sourceRelativeLinksProjectFolder +"/docs/content" +none + + +Purpose: +Source file based relative linking Hugo Project sub-folder.
+When `sourceRelativeLinksEval` is enabled, source level paths may contain an absolute respository path to the +markdown or static file which needs to be removed before trying to match it with the intended link. + For example, if your documentation is in `/docs/content`, then +`[example](/docs/content/other/page.md)` in `/docs/content/total/overview.md` will be linked to +`/docs/content/other/overview.md`, and then rendered to `/other/overview/` in the HTML output. + + +