Files
hinode/data/structures/file.yml
2023-12-29 14:51:00 +01:00

41 lines
1.2 KiB
YAML

comment: >-
Print the full content of any given file supported by the Chroma syntax
highlighter.
arguments:
path:
type: string
optional: false
comment: >-
Path of the input file. The path is relative to the `basePath` defined in
the `docs` section of the site's parameters. If the file starts with `./`,
the path of the repository is used as base path instead.
lang:
type: string
optional: true
comment: >-
Language to be used by the syntax highlighter. If not set, the
language is derived from the file extension.
show:
type: bool
optional: true
comment: >-
If unset, shows the panel with the code in collapsed state. By default,
the panel is expanded.
full:
type: bool
optional: true
default: true
comment: >-
If unset, shows the filename only. By default, the entire path (relative
to the base path) is shown.
id:
type: string
optional: true
comment: >-
Identifier of the collapse panel, defaults to `file-collapse-n` with a
sequential number `n` starting at 1.
class:
type: string
optional: true
comment: Class attribute of the tab control that wraps the file element.