Skip to content

Document the --package/-P and --readme/-R flags #64

Closed
@hegemonic

Description

@hegemonic

In JSDoc 3.3.0, you can use the --package/-P and --readme/-R command-line flags to specify the package and README files. If you omit these flags, JSDoc will look for files named package.json and README.md, respectively, and use those files if it finds them. This behavior is consistent with previous versions. (See jsdoc/jsdoc#708 for more info.)

We need to document this change.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions