|
6 år sedan | |
---|---|---|
.. | ||
archetypes | 481bfdb94f HDDS-89. Create ozone specific inline documentation as part of the build. | 7 år sedan |
content | 692736f7cf HDDS-280. Support ozone dist-start-stitching on openbsd/osx. Contributed by Elek, Marton. | 6 år sedan |
dev-support | 43be9ab44f HDDS-89. Addendum Patch-1. Create ozone specific inline documentation as part of the build. | 7 år sedan |
static | 2d13e410d8 HDDS-119. Skip Apache license header check for some ozone doc scripts. Contributed by Ajay Kumar. | 6 år sedan |
themes | 481bfdb94f HDDS-89. Create ozone specific inline documentation as part of the build. | 7 år sedan |
README.md | 481bfdb94f HDDS-89. Create ozone specific inline documentation as part of the build. | 7 år sedan |
config.toml | 481bfdb94f HDDS-89. Create ozone specific inline documentation as part of the build. | 7 år sedan |
pom.xml | 2d13e410d8 HDDS-119. Skip Apache license header check for some ozone doc scripts. Contributed by Ajay Kumar. | 6 år sedan |
This subproject contains the inline documentation for Ozone/HDDS components.
You can create a new page with:
hugo new content/title.md
You can check the rendering with:
hugo serve
This maven project will create the rendered HTML page during the build (ONLY if hugo is available). And the dist project will include the documentation.
You can adjust the menu hierarchy with adjusting the header of the markdown file:
To show it in the main header add the menu entry:
---
menu: main
---
To show it as a subpage, you can set the parent. (The value could be the title of the parent page,
our you can defined an id: ...
in the parent markdown and use that in the parent reference.
---
menu:
main:
parent: "Getting started"
---