Giter VIP home page Giter VIP logo

typedoc-plugin-rename-defaults's Introduction

typedoc-plugin-rename-defaults

A TypeDoc plugin that renames the default exports to their original name.

Why?

Since TypeDoc 0.20, the default exports fields do not get documented with their original names, but with the name "default". This plugin restores the behavior of TypeDoc 0.19 by keeping the original field name in the documentation. See typedoc#1521 for more context.

Usage

Just install the plugin and TypeDoc will load it automatically.

npm install --save-dev typedoc-plugin-rename-defaults

For TypeDoc 0.22 and up, you will need to add --entrypointStrategy expand to the typedoc command. Example:

// package.json

{
    "scripts": {
        "build-docs": "typedoc --entryPointStrategy expand src/"
    }
}

Credits

The initial implementation of this plugin was proposed by @Gerrit0 at typedoc#1521.

typedoc-plugin-rename-defaults's People

Contributors

felipecrs avatar axeemhaider avatar hiimjustin000 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.