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 adds extras to the generated documentation (favicon and date/time of generation).

  • 1.1.3
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
3.1K
decreased by-38.78%
Maintainers
1
Weekly downloads
 
Created
Source

typedoc-plugin-extras

This plugin only works for HTML documentation.

A plugin for TypeDoc that adds extras to the generated documentation (favicon and date/time of generation).

  • It can find the <head> of the document and append a favicon to it.
  • It can also add date/time of generation after "Generated using TypeDoc" in the footer (see Example).

No date/time will be added if --hideGenerator is set (because the footer wouldn't exist).

Feel free to ask for another extras or to make a PR 😉

npm

Example

Example

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.

  • --favicon
    Specify the name of the favicon file. Default: 'public/favicon.ico'
  • --noFavicon
    Disable the favicon.
  • --hideDate
    Hide the date at the end of documentation pages.
  • --hideTime
    Hide the time at the end of documentation pages.

Note: Favicon, date and time are enabled by default. When favicon is enabled, its file is copied into the documentation's output directory (--out).

License

MIT

Keywords

FAQs

Package last updated on 24 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

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc