esdoc2-brand-plugin

A brand plugin for esdoc2

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
esdoc2-brand-plugin
2.0.05 years ago5 years agoMinified + gzip package size for esdoc2-brand-plugin in KB

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 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