MkDoc can embed examples in the LinkML class documentation
https://linkml.io/linkml/generators/docgen.html
Examples can optionally be integrated into the documentation; to enable this, pass in the –example-directory argument. The example directory should contain one file per example, following the naming convention -..
For example, to include examples on the page for Person, include examples
Person-001.yaml, Person-002.yaml, etc.
Currently examples must be in yaml
MkDocs option:
example-directory <example_directory>
Folder in which example files are found. These are used to make inline examples
MkDoc can embed examples in the LinkML class documentation
https://linkml.io/linkml/generators/docgen.html
Examples can optionally be integrated into the documentation; to enable this, pass in the –example-directory argument. The example directory should contain one file per example, following the naming convention -..
For example, to include examples on the page for Person, include examples
Person-001.yaml, Person-002.yaml, etc.
Currently examples must be in yaml
MkDocs option:
example-directory <example_directory>
Folder in which example files are found. These are used to make inline examples