In addition to the children
property defining lower pages in the site structure, they can also be used to define
inline sections within the current document. Inclusion in this way produces a menu link to an anchor in the current page.
Below is an example from /guide/ops/persistence/index.md:
children:
- { section: Command Line Options }
- { section: File-based Persistence }
- { section: Object Store Persistence }
- { section: Rebinding to State }
- { section: Writing Persistable Code }
- { section: Persisted State Backup }
Inline sections can also be detected from separate, child .md
files. Including the tag check_directory_for_children: true
in the YAML front matter of a page causes the site structure plug-in to look through the current directory for any .md
files
containing section_type: inline
in the YAML front matter.
The content from these inline sections can then be included in the page content using the liquid tag child_content
. This is shown below
in an example from /guide/locations/index.md:
--- title: Locations layout: website-normal check_directory_for_children: true --- Locations are the environments to which Brooklyn deploys applications, including: Brooklyn supports a wide range of locations: * <a href="#clouds">Clouds</a>, where it will provision machines * <a href="#localhost">Localhost</a> (e.g. your laptop), where it will deploy via `ssh` to `localhost` for rapid testing * <a href="#byon">BYON</a>, where you "bring your own nodes", specifying already-existing hosts to use * And many others, including object stores and online services Configuration can be set in `brooklyn.cfg` or directly in YAML when specifying a location. On some entities, config keys determining matching selection and provisioning behavior can also be set in `provisioning.properties`. {% child_content %}