Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

esdoc-named-import-plugin

amirmohsen21MIT0.0.0

A named import plugin for ESDoc

flexverse, esdoc, named, import, plugin, documentation, doc

readme

ESDoc Named Import Plugin

This plugin turns basic import statements used in the generated documentation for classes into named imports.

Before:

import ClassName from 'package-name/path-to-class-name/ClassName';

After:

import {ClassName} from 'package-name';

Install

npm install esdoc-named-import-plugin

or

yarn add esdoc-named-import-plugin

Config

{
    "source": "./src",
    "destination": "./doc",
    "plugins": [
        {
            "name": "esdoc-named-import-plugin"
        }
    ]
}

changelog

Change Log

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog and this project adheres to Semantic Versioning.

0.0.0 - 2017-12-14

Added

  • Initial release