Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Refine docs #188

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
markdumay merged 3 commits into from
Aug 23, 2023
Merged

Refine docs #188

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
515b041
Add navbar size argument
markdumay Aug 22, 2023
786a957
Fix linting errors
markdumay Aug 23, 2023
b14e13d
Merge branch 'main' into develop
markdumay Aug 23, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions content/en/docs/latest/configuration/navigation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ The basic configuration of the navigation elements is set in the `navigation` se
| style | "light" | Style of the navigation bar, either "light" or "dark". It changes the colors of the menu items accordingly. |
| fixed | false | Flag indicating to keep the navigation bar fixed at the top of the screen. |
| offset | "3em" | Applies an {{</* link bs_navbar_placement >}}offset to main elements{{< /link */>}} when `fixed` is set to true. |
| size | "md" | Optional breakpoint of the navbar toggler, either "xs", "sm", "md" (default), "lg", or "xl". |
| search | true | Flag indicating to include a search input. |
| breadcrumb | false | Flag indicating to add breadcrumb navigation to the top of any single page. List pages are excluded. |
| toc | true | Flag indicating to enable table of contents globally. Individual pages can override this setting in the frontmatter using the value `includeToc`. |
Expand Down
6 changes: 6 additions & 0 deletions content/en/docs/latest/content/links-and-cross-references.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,19 +11,23 @@ layout: docs

Hugo provides the shortcode `ref` to link to another page within the site. The shortcode returns an absolute path. You can provide the document path as input. If you omit the leading `/`, the page is first resolved relative to the current page, then to the remainder of the site. Review {{< link hugo_links >}}Hugo's documentation{{< /link >}} for more examples and advanced options.

<!-- markdownlint-disable MD037 -->
{{< example lang="hugo" >}}
[Tables]({{</*ref "tables" */>}})

[About]({{</*ref "credits" */>}})
{{< /example >}}
<!-- markdownlint-enable MD037 -->

Similar to the `ref` shortcode, Hugo provides the shortcode `relref` to return a path relative to the current page.

<!-- markdownlint-disable MD037 -->
{{< example lang="hugo" >}}
[Tables]({{</*relref "tables" */>}})

[About]({{</*relref "credits" */>}})
{{< /example >}}
<!-- markdownlint-enable MD037 -->

## Cross-references

Expand All @@ -41,11 +45,13 @@ produces the following HTML:

You can add a cross-reference to the section heading by specifying the generated ID as input for the `ref` and `relref` shortcodes, preceded by a `#`.

<!-- markdownlint-disable MD037 -->
{{< example lang="hugo" >}}
[Reference]({{</* ref "#reference" */>}})

[Reference]({{</* relref "#reference" */>}})
{{< /example >}}
<!-- markdownlint-enable MD037 -->

## External links

Expand Down