New Case Study:See how Anthropic automated 95% of dependency reviews with Socket.Learn More
Socket
Sign inDemoInstall
Socket

typedoc-plugin-extras

Package Overview
Dependencies
Maintainers
1
Versions
27
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

typedoc-plugin-extras

A plugin for TypeDoc that enables to add little extras to the generated documentation.

1.1.0
Source
npm
Version published
Weekly downloads
7.3K
-5.45%
Maintainers
1
Weekly downloads
 
Created
Source

typedoc-plugin-extras

This plugin only works for HTML documentation.

A plugin for TypeDoc that enables to add a extras to the generated documentation.

It finds the <head> and appends the favicon to it. It can also add date and/or time of generation after "Generated using TypeDoc".

No date/time will be added if --hideGenerator is set.

npm

Installation

npm install --save-dev typedoc typedoc-plugin-extras

Usage

$ npx typedoc --plugin typedoc-plugin-extras [args]

Arguments

The following arguments can be used in addition to the default TypeDoc arguments.

The favicon, date and time are automatically added by default. The favicon is copied into the output documentation directory.

  • --favicon
    Specify the name of the favicon file. Defaults to 'public/favicon.ico'.
  • --noFavicon
    Disable the favicon.
  • --hideDate
    Hides the date of generation at the end of documentation pages.
  • --hideTime
    Hides the time of generation at the end of documentation pages.

License

MIT

Keywords

date

FAQs

Package last updated on 10 May 2020

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts