Sentry Maven Skin 6.4.01
-
Home
- User Documentation Features 14
Navigation Links
At the very top of each page, the navigation bar allows you to include a logo and link to your organization, as well as links to other resources, typically outside of the generated documentation (links to pages inside the documentation are normally listed in the menu on the left), as in the example below:
In mobile view, the main link to your organization is displayed at the top of the page, and other links at the very bottom of the page, to make the page easier to read:
<bannerLeft>
The first link and logo on the left in this navigation bar is specified with <bannerLeft> in src/site/site.xml:
<project name="My Documentation">
<bannerLeft>
<src>images/logo-short.png</src>
<name>Banner Left</name>
<href>https://banner.left</href>
</bannerLeft>
The <src> property refers to an image storage in the src/resources directory. For better result, please ensure the image follows these rules:
- Height of 40px to 80px (the image will be resized to 40 pixels in height to fit the bar)
- Transparent background (PNG is strongly recommended)
- Light colors (to ensure contrast with the dark color of the bar)
If you don't have any logo to display, simply use the <name> property to specify the text to display for the main link in the navigation bar. Both <src> and <name> are optional, you only need to specify one of these properties.
<links>
In src/site/site.xml, use the <links> tag under <body> to specify links in the top navigation bar. Specify each link as an <item> element[1]:
<project name="My Documentation">
...
<body>
...
<links>
<item name="Fork on GitHub" href="${project.scm.url}" />
<item name="Maven Site Plugin" href="https://maven.apache.org/plugins/maven-site-plugin" />
<item name="Maven Site Descriptor" href="https://maven.apache.org/plugins/maven-site-plugin/examples/sitedescriptor.html" />
<item name="Other Maven Skins" href="https://maven.apache.org/skins" />
</links>
<social>
You can specify one or several social networks to link to in the top navigation bar, so your readers can subscribe easily. In src/site/site.xml, use the <social> element under <custom> to list your social networks:
| Social network | Configuration |
|---|---|
<facebook>YourAccount</facebook> |
|
<linkedin>in/YourAccount</linkedin> for a personnal account<linkedin>company/YourAccount</linkedin> for an organization |
|
<twitter>YourHandle</twitter> |
|
| Other |
|
The below example declares 2 social networks in src/site/site.xml to be included in the top navigation bar, Twitter and Slack:
<project name="My Documentation">
...
<custom>
<social>
<twitter>TheASF</twitter>
<custom>
<title>Join us on Slack!</title>
<href>https://infra.apache.org/slack.html</href>
<icon>fa-brands fa-slack</icon>
</custom>
</social>
...
</custom>
<bannerRight>
Very similar to <bannerLeft>, this element will be displayed on the right of the navigation bar. You can specify either <src>, <name>, or both.
<additionalLinks>
In src/site/site.xml, use the <additionalLinks> tag under <custom> to specify additional links in the footer of the page. Such additional links are typically used for mandatory legal documents, like terms of use, disclaimer, privacy policy, etc.
Specify each link as a <link> element, as in the example below:
<project name="My Documentation">
...
<custom>
<additionalLinks>
<link>
<name>My Link Text</name>
<href>https://w3c.org</href>
<target>_blank</href>
</link>
<link>
<name>Another Useful Link</name>
<href>https://onehome.org</href>
</link>
</additionalLinks>
...
</custom>