Converter of vocabulary in YAML format into Turtle/JSON-LD/HTML+RDFa - v1.12.0
    Preparing search index...

    Function generateVocabularyFiles

    • The most common usage, currently, of the library: convert a YAML file into Turtle, JSON-LD, and HTML, using a common basename for all three files, derived from the YAML file itself. The resulting vocabulary files are stored on the local file system.

      If the YAML file is incorrect (i.e., either the YAML parser or the Schema validation reports an error), an error message is printed on the console and no additional files are generated.

      Parameters

      • yaml_file_name: string

        the vocabulary file in YAML

      • template_file_name: string

        the HTML template file

      • context: boolean

        whether the JSON-LD context file should also be generated

      • yamlVocab: boolean = false

        whether the YAML-LD version of the vocabulary should also be generated

      • debug: boolean = false

        display a full stack if an error is reported

      Returns Promise<void>

      on error situation in reading the input files, in yml validation, or when writing the result