typedoc-plugin-extras - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

dist/index.js

@@ -12,3 +12,3 @@ "use strict";
         name: 'favicon',
-        help: 'Extras Plugin: The name of the favicon file.',
+        help: 'Extras Plugin: Specify the name of the favicon file.',
         type: utils_1.ParameterType.String,
@@ -18,2 +18,8 @@ defaultValue: 'public/favicon.ico'
     app.options.addDeclaration({
+        name: 'no-favicon',
+        help: 'Extras Plugin: Disable the favicon.',
+        type: utils_1.ParameterType.Boolean,
+        defaultValue: false
+    });
+    app.options.addDeclaration({
         name: 'hideDate',
@@ -32,2 +38,5 @@ help: 'Extras Plugin: Hides the date of generation at the end of documentation pages.',
     app.renderer.once(events_1.RendererEvent.END, () => {
+        const noFavicon = app.options.getValue('no-favicon');
+        if (noFavicon)
+            return;
         const faviconPath = app.options.getValue('favicon');
@@ -34,0 +43,0 @@ const workingDir = process.cwd();

dist/plugin.js

@@ -14,7 +14,10 @@ "use strict";
         const document = dom.window.document;
+        const noFavicon = this.application.options.getValue('no-favicon');
         const favicon = path_1.basename(this.application.options.getValue('favicon'));
         const hideDate = this.application.options.getValue('hideDate');
         const hideTime = this.application.options.getValue('hideTime');
-        const head = document.querySelector('head');
-        head.innerHTML += `<link rel="icon" href="${favicon}" />`;
+        if (!noFavicon) {
+            const head = document.querySelector('head');
+            head.innerHTML += `<link rel="icon" href="${favicon}" />`;
+        }
         if (!hideDate || !hideTime) {
@@ -21,0 +24,0 @@ const p = document.querySelector('body > div.container.tsd-generator > p');

package.json

 {
     "name": "typedoc-plugin-extras",
-    "version": "1.0.0",
+    "version": "1.0.1",
     "description": "A plugin for TypeDoc that enables to add little extras to the generated documentation.",
@@ -5,0 +5,0 @@ "main": "dist/index.js",

README.md

@@ -23,4 +23,15 @@ # typedoc-plugin-extras
 
+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'`.
+- `--no-favicon`<br>
+  Disable the favicon.
+- `--hideDate`<br>
+  Hides the date of generation at the end of documentation pages.
+- `--hideTime`<br>
+  Hides the time of generation at the end of documentation pages.
+
 ## License
 
 [MIT](https://github.com/Drarig29/typedoc-plugin-extras/blob/master/LICENSE)

No alert changes

Improved metrics

Total package byte prevSize

6837

increased by14.68%

Lines of code

83

increased by16.9%

Number of lines in readme file

37

increased by42.31%

No dependency changes