Security News
How Threat Actors are Abusing GitHub’s File Upload Feature to Host Malware
GitHub is susceptible to a CDN flaw that allows attackers to host malware on any public repository.
typedoc-plugin-extras
Advanced tools
Readme
This plugin only works for HTML documentation.
A TypeDoc plugin to add extras to the output documentation.
It allows you to:
--name
would do).
--customTitle "Go back" --titleLink <url-of-your-parent-documentation>
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 😉
You also can view an example documentation using the plugin here:
https://drarig29.github.io/typedoc-plugin-extras/
npm install --save-dev typedoc-plugin-extras
$ npx typedoc --plugin typedoc-plugin-extras [args]
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".
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
FAQs
A TypeDoc plugin to add extras (favicon, description, generation date...) to the output documentation
The npm package typedoc-plugin-extras receives a total of 2,874 weekly downloads. As such, typedoc-plugin-extras popularity was classified as popular.
We found that typedoc-plugin-extras demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
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.
Security News
GitHub is susceptible to a CDN flaw that allows attackers to host malware on any public repository.
Security News
At Node Congress, Socket CEO Feross Aboukhadijeh uncovers the darker aspects of open source, where applications that rely heavily on third-party dependencies can be exploited in supply chain attacks.
Research
Security News
The Socket Research team found this npm package includes code for collecting sensitive developer information, including your operating system username, Git username, and Git email.