typedoc-plugin-extras
Advanced tools
Comparing version 2.2.3 to 2.2.4
@@ -88,3 +88,3 @@ "use strict"; | ||
const now = new Date(); | ||
const date = ` the ${now.toLocaleDateString()}`; | ||
const date = ` on ${now.toLocaleDateString()}`; | ||
const time = ` at ${now.toLocaleTimeString()}`; | ||
@@ -91,0 +91,0 @@ let dateTime = ','; |
{ | ||
"name": "typedoc-plugin-extras", | ||
"version": "2.2.3", | ||
"description": "A plugin for TypeDoc that adds extras to the generated documentation (favicon and date/time of generation).", | ||
"version": "2.2.4", | ||
"description": "A plugin for TypeDoc which adds extras to the generated documentation", | ||
"main": "./dist/main.js", | ||
@@ -13,2 +13,3 @@ "exports": "./dist/main.js", | ||
"start": "tsc --watch", | ||
"pretest": "npm link && npm link typedoc-plugin-extras", | ||
"test": "typedoc --plugin typedoc-plugin-extras --favicon public/favicon.ico --footerDate --footerTime --footerTypedocVersion src/main.ts", | ||
@@ -15,0 +16,0 @@ "build": "tsc", |
@@ -5,7 +5,8 @@ # typedoc-plugin-extras | ||
A plugin for [TypeDoc](https://github.com/TypeStrong/typedoc) that adds extras to the generated documentation (favicon and date/time of generation). | ||
A plugin for [TypeDoc](https://github.com/TypeStrong/typedoc) which adds extras to the generated documentation. | ||
- It can set custom top-most title name and/or link | ||
- 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). | ||
- It can set a custom top-most title name and/or link. | ||
- It can find the `<head>` of the documents and append a favicon to it. | ||
- It can also add date/time of generation after "Generated using TypeDoc" in the footer. (cf. the [example](https://github.com/Drarig29/typedoc-plugin-extras#example) below) | ||
- And more... (cf. the list of [arguments](https://github.com/Drarig29/typedoc-plugin-extras#arguments) below) | ||
@@ -81,13 +82,6 @@ **No date/time will be added if `--hideGenerator` is set (because the footer wouldn't exist).** | ||
Then, link the package to the current repo, to have it in the local `node_modules`: | ||
```bash | ||
npm link | ||
npm link typedoc-plugin-extras | ||
``` | ||
You can now generate the documentation with the plugin (from the source): | ||
```bash | ||
npm run test | ||
npm test | ||
``` | ||
@@ -94,0 +88,0 @@ |
Sorry, the diff of this file is not supported yet
26400
11
306
90
2