npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

typedoc-plugin-extras

v3.0.0

Published

A TypeDoc plugin to add extras (favicon, description, generation date...) to the output documentation

Downloads

16,310

Readme

typedoc-plugin-extras

npm

This plugin only works for HTML documentation.

A TypeDoc plugin to add extras to the output documentation.

It allows you to:

  • Set a custom favicon.
  • Add the date/time of generation after "Generated using TypeDoc" in the footer. (cf. the example below)
  • Set a custom top-most title name (without changing the package name, like --name would do).
    • For example, you could have --customTitle "Go back" --titleLink <url-of-your-parent-documentation>
  • And more... (cf. the list of arguments below)

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

All extras are disabled by default: they are opt-in.

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

Example

example

You also can view an example documentation using the plugin here:

https://drarig29.github.io/typedoc-plugin-extras/

Installation

npm install --save-dev 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.

  • --customTitle Specify a custom title, for the top-most title only. Example: foo

  • --customDescription Specify a custom <meta name="description" property. Example: An example description

  • --favicon Specify the path or URL of the favicon file. Example: public/favicon.ico Note: If given a path, the favicon file is copied into the documentation's output directory (--out).

  • --footerTypedocVersion Appends the TypeDoc version in the footer. Default: false

  • --footerLastModified Appends a "Last Modified" text in the footer (e.g. "Last modified 6 min. ago"). Default: false Note: If specified, the --footerDate and --footerTime options are ignored.

  • --footerDate (deprecated) Appends the date of generation in the footer (e.g. "Jul 29, 2022"). Default: false Note: If combined with --footerTime, it will append "Jul 29, 2022, 3:44:42 PM GMT+2".

  • --footerTime (deprecated) Appends the time of generation in the footer (e.g. "3:44:42 PM GMT+2"). Default: false Note: If combined with --footerDate, it will append "Jul 29, 2022, 3:44:42 PM GMT+2".

Testing

To test this plugin, you can generate TypeDoc documentation for this plugin.

To do so, you'll first need to build it:

npm run build

Then, you can generate the documentation with the plugin (from source):

npm test

License

MIT