Markdown
Overview
Markdown is a simple format for authoring documentation. Static site generation frameworks such as mkdocs use markdown to simply the creation of websites.
Using LinkML you can go from a schema to a complete searchable website hosted on GitHub in minutes thanks to the markdown generator
See for example:
To run:
gen-json-schema -d docs personinfo.yaml
Docs
Command Line
gen-markdown
Generate markdown documentation of a LinkML model
gen-markdown [OPTIONS] YAMLFILE
Options
- -d, --dir <dir>
Output directory
- -c, --classes <classes>
Class(es) to emit
- -i, --img
Download YUML images to ‘image’ directory
- -I, --index-file <index_file>
Name of markdown file that holds index
- --noimages
Do not (re-)generate images
- --noyuml
Do not add yUML figures to pages
- --notypesdir
Do not create a separate types directory
- --warnonexist
Warn if output file already exists
- -f, --format <format>
Output format (default=md)
- Options
md
- --metadata, --no-metadata
Include metadata in output (default=–metadata)
- --useuris, --metauris
Include metadata in output (default=–useuris)
- -im, --importmap <importmap>
Import mapping file
- --log_level <log_level>
Logging level (default=WARNING)
- Options
CRITICAL | ERROR | WARNING | INFO | DEBUG
- --mergeimports, --no-mergeimports
Merge imports into source file (default=mergeimports)
Arguments
- YAMLFILE
Required argument
Code
- class linkml.generators.markdowngen.MarkdownGenerator(schema: Union[str, TextIO, linkml_runtime.linkml_model.meta.SchemaDefinition], no_types_dir: bool = False, noyuml: bool = False, warn_on_exist: bool = False, **kwargs)[source]
- serialize(**kwargs) str
Generate output in the required format
- Parameters
kwargs – Generater specific parameters
- Returns
Generated output