typedoc-github-wiki-theme - npm Package Compare versions

Comparing version 1.0.1 to 1.1.0

dist/index.d.ts

 import { Application } from 'typedoc';
 export declare function load(app: Application): void;

dist/index.js

@@ -5,5 +5,7 @@ "use strict";
 const theme_1 = require("./theme");
+const options_reader_1 = require("./options-reader");
 function load(app) {
     app.renderer.defineTheme('github-wiki', theme_1.GithubWikiTheme);
+    app.options.addReader(new options_reader_1.GithubWikiThemeOptionsReader());
 }
 exports.load = load;

dist/theme.d.ts

@@ -0,0 +0,0 @@ import { DeclarationReflection, Renderer } from 'typedoc';

dist/theme.js

 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.GithubWikiTheme = void 0;
-const fs = require("fs");
+const fs = __importStar(require("fs"));
 const typedoc_1 = require("typedoc");
@@ -6,0 +29,0 @@ const typedoc_plugin_markdown_1 = require("typedoc-plugin-markdown");

package.json

 {
   "name": "typedoc-github-wiki-theme",
-  "version": "1.0.1",
+  "version": "1.1.0",
   "description": "An extension of the default theme from typedoc-plugin-markdown to create a compatible file structure for Github Wiki pages.",
@@ -20,7 +20,5 @@ "main": "dist/index.js",
     "lint": "eslint ./src --ext .ts",
-    "prepublishOnly": "yarn run lint && yarn run build && yarn run test",
+    "prepublishOnly": "yarn run lint && yarn run build",
     "build": "rm -rf ./dist && tsc",
-    "test": "jest --colors",
-    "build-and-test": "yarn run build && yarn run test",
-    "demo": "rm -rf ./demo && yarn run build && typedoc --options ../typedoc-plugin-markdown/demo.options.json  --tsconfig ../typedoc-plugin-markdown/test/stubs/tsconfig.json --theme github-wiki --out ./demo"
+    "demo": "rm -rf ./demo && yarn run build && typedoc --plugin typedoc-plugin-markdown --plugin typedoc-github-wiki-theme --options ../../stub-project/typedoc-options.json --out ./demo"
   },
@@ -30,5 +28,8 @@ "author": "Thomas Grey",
   "peerDependencies": {
-    "typedoc": ">=0.22.9",
-    "typedoc-plugin-markdown": ">=3.11.10"
+    "typedoc": ">=0.24.0",
+    "typedoc-plugin-markdown": ">=3.15.0"
   },
+  "devDependencies": {
+    "typedoc-plugin-markdown": "^3.15.0"
+  },
   "keywords": [
@@ -38,4 +39,3 @@ "typedoc",
     "githubwiki"
-  ],
-  "gitHead": "71b0cafc9f710f13019052b0b6591dfd3907c9e5"
+  ]
 }

README.md

@@ -8,3 +8,3 @@ # typedoc-github-wiki-theme
 
-## What is does?
+## What Does It Do?
 
@@ -24,3 +24,3 @@ - Generates Wiki friendly file names.
 ```bash
-$ npx typedoc --theme github-wiki [args]
+$ npx typedoc --plugin typedoc-plugin-markdown --plugin typedoc-github-wiki-theme [args]
 ```
@@ -27,0 +27,0 @@

No alert changes

Improved metrics

Total package byte prevSize

8372

increased by26.66%

Number of package files

9

increased by28.57%

Lines of code

116

increased by70.59%

Worsened metrics

Dev dependency count

1

increased byInfinity%

No dependency changes