LibrarianGeneratePages.md

librarianGeneratePages

Description

generate page, must execute after librarianGenerateArtifacts

Related Configuration

• librarian.dataFolderName
  • String
  • default: Library
  • output root folder name
• librarian.depth
  • String, firstLevel or allLevel
  • default: firstLevel
  • search dependency depth, firstLevel find your directly dependency
• librarian.ignoreArtifacts
  • Array of String
  • ignore notice of maven artifact, ignore by prefix match
• librarian.failOnGeneratePageWhenFoundPlaceholder
  • Boolean
  • default: true
  • fail on librarianGeneratePages when found placeholder
• librarian.failOnOverrideUnMatchedLicense
  • Boolean
  • default: true
  • fail on override un matched license by group
• librarian.failOnTooManyResolvingConfigurationLimit
  • Int
  • default: 1000
  • fail limit that resolving configurations too many, multi module project will be increase exponentially
• librarian.pages
  • NamedDomainObject
  • see sample code

Result

write result at /${dataFolderName}/${page.name}/

Markdown:

# Title
*This markdown is auto generated by [Librarian](https://github.com/MeilCli/Librarian)*

Description

## Using
|Name|author|license|
|:--|:--|:--|
|[Example](https://google.com)|Example human|[Example license](https://google.com)|

Json:

{
    "title": "Example",
    "description": "Example",
    "notices": [
        {
            "name": "Example",
            "author": "Example human",
            "url": "https://google.com",
            "description": "Description is optional, will be null",
            "resources": [
                {
                    "artifacts": [
                        "com.example:example"
                    ],
                    "licenses": [
                        {
                            "name": "Example license",
                            "url": "https://google.com"
                        }
                    ]
                }
            ]
        }
    ]
}