typedoc-plugin-extras - npm Package Compare versions

Comparing version 1.1.1 to 1.1.2

dist/index.js

		@@ -24,3 +24,3 @@ "use strict";
		name: 'hideDate',
		help: 'Extras Plugin: Hides the date of generation at the end of documentation pages.',
		help: 'Extras Plugin: Hide the date of generation at the end of documentation pages.',
		type: utils_1.ParameterType.Boolean,
		@@ -31,3 +31,3 @@ defaultValue: false
		name: 'hideTime',
		help: 'Extras Plugin: Hides the time of generation at the end of documentation pages.',
		help: 'Extras Plugin: Hide the time of generation at the end of documentation pages.',
		type: utils_1.ParameterType.Boolean,
		@@ -34,0 +34,0 @@ defaultValue: false

package.json

		{
		"name": "typedoc-plugin-extras",
		"version": "1.1.1",
		"version": "1.1.2",
		"description": "A plugin for TypeDoc that adds extras to the generated documentation (favicon and date/time of generation).",
		@@ -5,0 +5,0 @@ "main": "dist/index.js",

README.md

		@@ -7,7 +7,9 @@ # typedoc-plugin-extras

		* It can find the `<head>` of the document and appends a favicon to it.
		* It can also add date and/or time of generation after "Generated using TypeDoc".
		* 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.
		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](https://img.shields.io/npm/v/typedoc-plugin-extras.svg)](https://www.npmjs.com/package/typedoc-plugin-extras)
		@@ -35,15 +37,16 @@

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

		- `--favicon`<br>
		Specify the name of the favicon file. Defaults to `'public/favicon.ico'`.
		Specify the name of the favicon file. Default: `'public/favicon.ico'`
		- `--noFavicon`<br>
		Disable the favicon.
		- `--hideDate`<br>
		Hides the date of generation at the end of documentation pages.
		Hide the date at the end of documentation pages.
		- `--hideTime`<br>
		Hides the time of generation at the end of documentation pages.
		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](https://github.com/Drarig29/typedoc-plugin-extras/blob/master/LICENSE)

typedoc-plugin-extras - npm Package Compare versions

Improved metrics