@apitree.cz/typedoc-config 0.0.0

package/README.md

@@ -0,0 +1,39 @@
+<div align="center">
+
+<a href="https://github.com/ApiTreeCZ">
+<img alt="ApiTree s.r.o." src="https://www.apitree.cz/static/images/logo-header.svg" width="120" />
+</a>
+
+# TypeDoc Config
+
+### [TypeDoc](https://typedoc.org) configuration for ApiTree projects
+
+</div>
+
+## Installation
+
+```bash
+pnpm add --save-dev @apitree.cz/typedoc-config typescript
+```
+
+## Usage
+
+Add the following configuration to your `typedoc.config.js`:
+
+```javascript
+export { config as default } from '@apitree.cz/typedoc-config';
+```
+
+### Custom Entry Points
+
+The default configuration picks `./src/index.ts` in your package as the documentation entry point, however, you can
+change this by overriding the `entryPoints` property in your `typedoc.config.js`:
+
+```javascript
+import { config } from '@apitree.cz/typedoc-config';
+
+export default {
+  ...config,
+  entryPoints: ['./src/module-a/index.ts', './src/module-b/index.ts'],
+};
+```

package/dist/config.d.ts

@@ -0,0 +1,9 @@
+export declare const config: {
+    hideBreadcrumbs: boolean;
+    entryPoints: string[];
+    githubPages: false;
+    gitRevision: string;
+    out: string;
+    plugin: string[];
+    readme: string;
+};

package/dist/config.js

@@ -0,0 +1,16 @@
+const base = {
+    entryPoints: ['./src/index.ts'],
+    githubPages: false,
+    gitRevision: 'develop',
+    out: './docs',
+    plugin: ['typedoc-plugin-markdown'],
+    readme: 'none',
+};
+const extra = {
+    hideBreadcrumbs: true,
+};
+export const config = {
+    ...base,
+    ...extra,
+};
+//# sourceMappingURL=config.js.map

package/dist/config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAEA,MAAM,IAAI,GAAG;IACX,WAAW,EAAE,CAAC,gBAAgB,CAAC;IAC/B,WAAW,EAAE,KAAK;IAClB,WAAW,EAAE,SAAS;IACtB,GAAG,EAAE,QAAQ;IACb,MAAM,EAAE,CAAC,yBAAyB,CAAC;IACnC,MAAM,EAAE,MAAM;CACmB,CAAC;AAEpC,MAAM,KAAK,GAAG;IACZ,eAAe,EAAE,IAAI;CACtB,CAAC;AAEF,MAAM,CAAC,MAAM,MAAM,GAAG;IACpB,GAAG,IAAI;IACP,GAAG,KAAK;CACT,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1 @@
+export * from './config.js';

package/dist/index.js

@@ -0,0 +1,2 @@
+export * from './config.js';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC"}

package/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "@apitree.cz/typedoc-config",
+  "version": "0.0.0",
+  "description": "TypeDoc configuration for ApiTree projects.",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ApiTreeCZ/toolbox",
+    "directory": "packages/typedoc-config"
+  },
+  "sideEffects": false,
+  "type": "module",
+  "exports": "./dist/index.js",
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "typedoc": "^0.25.3",
+    "typedoc-plugin-markdown": "^3.16.0"
+  },
+  "devDependencies": {
+    "typescript": "^5.2.2"
+  },
+  "peerDependencies": {
+    "typescript": "^5.2.2"
+  },
+  "scripts": {
+    "build": "tsc --build tsconfig.build.json",
+    "cleanup": "rimraf .eslintcache .turbo tsconfig.tsbuildinfo tsconfig.build.tsbuildinfo dist node_modules",
+    "fix": "run-p ts format:fix lint:fix",
+    "format": "prettier --check \"./**/*.{json,md}\"",
+    "format:fix": "pnpm run format --write",
+    "lint": "eslint --cache --ext cjs,js,ts .",
+    "lint:fix": "pnpm run lint --fix",
+    "qa": "run-p ts format lint",
+    "ts": "tsc --build tsconfig.json"
+  }
+}