esdoc-standard-plugin

    1.0.0 • Public • Published

    ESDoc Standard Plugin

    Install

    npm install esdoc-standard-plugin

    Config

    {
      "source": "./src",
      "destination": "./doc",
      "plugins": [
        {
          "name": "esdoc-standard-plugin",
          "option": {
            "lint": {"enable": true},
            "coverage": {"enable": true},
            "accessor": {"access": ["public", "protected", "private"], "autoPrivate": true},
            "undocumentIdentifier": {"enable": true},
            "unexportedIdentifier": {"enable": false},
            "typeInference": {"enable": true},
            "brand": {
              "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"
            },
            "manual": {
              "index": "./manual/index.md",
              "globalIndex": true,
              "asset": "./manual/asset",
              "files": [
                "./manual/overview.md",
                "./manual/design.md",
                "./manual/installation.md",
                "./manual/usage1.md",
                "./manual/usage2.md",
                "./manual/tutorial.md",
                "./manual/configuration.md",
                "./manual/example.md",
                "./manual/advanced.md",
                "./manual/faq.md",
                "./CHANGELOG.md"
              ]
            },
            "test": {
              "source": "./test/",
              "interfaces": ["describe", "it", "context", "suite", "test"],
              "includes": ["(spec|Spec|test|Test)\\.js$"],
              "excludes": ["\\.config\\.js$"]
            }
          }
        }
      ]
    }

    The esdoc-standard-plugin is a glue plugin. The following plugins are used by this.

    LICENSE

    MIT

    Author

    Ryo Maruyama@h13i32maru

    Install

    npm i esdoc-standard-plugin

    DownloadsWeekly Downloads

    23,906

    Version

    1.0.0

    License

    MIT

    Last publish

    Collaborators

    • h13i32maru