Package Exports

esdoc-brand-plugin

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (esdoc-brand-plugin) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

ESDoc Brand Plugin

Install

npm install esdoc-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": "esdoc-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 is null
title default is name of package.json
description default is description of package.json
repository default is repository of package.json
site default is homepage of package.json
author default is author of package.json
image default is null. support an aspect ratio of 1:1

LICENSE

MIT

Author

Ryo Maruyama@h13i32maru