Skip to content

Commit

Permalink
0.0.1
Browse files Browse the repository at this point in the history
  • Loading branch information
NikolaRHristov committed Mar 19, 2024
1 parent 630a03c commit 7b7ccc0
Show file tree
Hide file tree
Showing 6 changed files with 24 additions and 47 deletions.
31 changes: 0 additions & 31 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,36 +22,5 @@ npm install -D -E typescript-document
}
```

### ESBuild Configuration

Or with a custom ESBuild config file:

`package.json`

```json
{
"scripts": {
"prepublishOnly": "TypeScriptDocument 'Source/**/*.ts' -es ESBuild.ts"
}
}
```

See an example of a configuration file in
[ESBuild.ts](Source/Variable/ESBuild.ts)

### TypeScript Configuration

`tsconfig.json`

```json
{
"compilerOptions": {
"outDir": "Target"
},
"extends": "typescript-document/Target/Notation/TypeScript",
"include": ["Source"]
}
```

[typedoc]: https://npmjs.org/typedoc
[TypeScriptDocument]: https://npmjs.org/typescript-document
28 changes: 20 additions & 8 deletions Source/Function/Document.ts
Original file line number Diff line number Diff line change
Expand Up @@ -15,21 +15,33 @@ export default (async (...[File]: Parameters<Type>) => {

console.log(Pipe);

Exec(
console.log(
[
"typedoc",
"--commentStyle all",
"--gitRevision main",
// "--gitRevision Current",
`--customCss ${resolve(`${Current}/../Stylesheet/Theme.css`)}`,
"--includeVersion",
"--out ./Documentation",
`--plugin ${resolve(`${Current}/../../Target/Variable/Load.js`)}`,
"--plugin typedoc-plugin-remove-references",
"--plugin typedoc-plugin-rename-defaults",
"--plugin typedoc-plugin-mdn-links",
"--plugin typedoc-plugin-zod",
"--plugin typedoc-plugin-merge-modules",
"--plugin typedoc-plugin-keywords",
`--plugin ${resolve(
`${Current}/../../node_modules/typedoc-plugin-remove-references/dist/index.js`,
)}`,
`--plugin ${resolve(
`${Current}/../../node_modules/typedoc-plugin-rename-defaults/index.js`,
)}`,
`--plugin ${resolve(
`${Current}/../../node_modules/typedoc-plugin-mdn-links/dist/index.js`,
)}`,
`--plugin ${resolve(
`${Current}/../../node_modules/typedoc-plugin-zod/dist/plugin.js`,
)}`,
`--plugin ${resolve(
`${Current}/../../node_modules/typedoc-plugin-merge-modules/dist/index.js`,
)}`,
`--plugin ${resolve(
`${Current}/../../node_modules/typedoc-plugin-keywords/index.js`,
)}`,
"--searchInComments",
`--keywords ${
(
Expand Down
7 changes: 2 additions & 5 deletions Source/Variable/Load.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,8 @@
* @module Load
*
*/
export const load = ((...[Application]: Parameters<Type["load"]>) =>
Application.renderer.defineTheme(
"TypeScriptDocument",
Theme,
)) satisfies Type["load"] as Type["load"];
export const load = (...[Application]: Parameters<Type["load"]>) =>
Application.renderer.defineTheme("TypeScriptDocument", Theme);

export default {
load,
Expand Down
2 changes: 1 addition & 1 deletion Target/Function/Document.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion Target/Variable/Load.js
Original file line number Diff line number Diff line change
@@ -1 +1 @@
const t=(...[e])=>e.renderer.defineTheme("TypeScriptDocument",a);var o={load:t};const{default:a}=await import("../Class/Theme.js");export{a as Theme,o as default,t as load};
const t=(...[e])=>e.renderer.defineTheme("TypeScriptDocument",r);var a={load:t};const{default:r}=await import("../Class/Theme.js");export{r as Theme,a as default,t as load};
1 change: 0 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,6 @@
"prepublishOnly": "TypeScriptESBuild 'Source/**/*.ts'"
},
"dependencies": {
"@types/node": "20.11.28",
"commander": "12.0.0",
"fast-glob": "3.3.2",
"typedoc": "0.25.12",
Expand Down

0 comments on commit 7b7ccc0

Please sign in to comment.