Package io.quarkus.docs.generation

Class YamlMetadataGenerator

java.lang.Object
io.quarkus.docs.generation.YamlMetadataGenerator
public class YamlMetadataGenerator extends Object
Iterate over the documents in the source directory. Creates two sets of files in the target directory:
  • index*.yaml, which contains metadata (id, title, file name, categories, summary, preamble) from each document. One file is organized by document type, another is organized by file name.
  • errors*.yaml, which lists all documents that have problems with required structure or metadata. One file is organized by document type, another is organized by file name.