View Source Ash.DocIndex behaviour (ash v1.53.0)
A module for configuring how a library is rendered in ash_hq.
There is a small template syntax available in any documentation. The template syntax will link to the user's currently selected version for the relevant library.
All templates should be wrapped in double curly braces, e.g {{}}
.
links-to-other-documentation
Links to other documentation
{{link:library:item_type:name}}
The only item_type currently supported is guide
, so the name would be category/name
For example:
{{link:ash:guide:Attributes}}
-> <a href="/docs/guides/ash/topics/attributes.md">Attributes</a>
mix-dependencies
Mix dependencies
{{mix_dep:library}}
For example:
{{mix_dep:ash}}
-> {:ash, "~> 1.5"}