esdoc2-brand-plugin
v2.0.0
Published
A brand plugin for esdoc2
Downloads
2,712
Maintainers
Readme
esdoc2 Brand Plugin
Install
npm install esdoc2-brand-plugin
Config
This plugin takes a title and a repository from package.json (name, repsitory)
.
{
"source": "./src",
"destination": "./doc",
"package.json": "./package.json",
"plugins": [
{
"name": "esdoc2-brand-plugin",
"option": {
"logo": "./logo.png",
"title": "My Library",
"description": "this is awesome library",
"repository": "https://github.com/foo/bar",
"site": "http://my-library.org",
"author": "https://twitter.com/foo",
"image": "http://my-library.org/logo.png"
}
}
]
}
logo
default isnull
title
default isname
ofpackage.json
description
default isdescription
ofpackage.json
repository
default isrepository
ofpackage.json
site
default ishomepage
ofpackage.json
author
default isauthor
ofpackage.json
image
default isnull
. support an aspect ratio of 1:1
LICENSE
MIT