From a9234785abd105d6dc155d5ad06faa728388d88f Mon Sep 17 00:00:00 2001 From: Sidharth Vinod Date: Mon, 31 Oct 2022 22:15:07 +0530 Subject: [PATCH] chore: Configure typedoc source links --- docs/config/setup/modules/config.md | 44 +++++++++++----------- docs/config/setup/modules/defaultConfig.md | 8 ++-- docs/config/setup/modules/mermaidAPI.md | 14 +++---- packages/mermaid/package.json | 2 +- packages/mermaid/typedoc.json | 11 ++++++ 5 files changed, 45 insertions(+), 34 deletions(-) create mode 100644 packages/mermaid/typedoc.json diff --git a/docs/config/setup/modules/config.md b/docs/config/setup/modules/config.md index 7c3f49bca..7ffd0b2bd 100644 --- a/docs/config/setup/modules/config.md +++ b/docs/config/setup/modules/config.md @@ -8,17 +8,17 @@ ## Variables -### defaultConfig +### defaultConfig • `Const` **defaultConfig**: `MermaidConfig` #### Defined in -config.ts:7 +[config.ts:7](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.ts#L7) ## Functions -### addDirective +### addDirective ▸ **addDirective**(`directive`): `void` @@ -36,11 +36,11 @@ Pushes in a directive to the configuration #### Defined in -config.ts:191 +[config.ts:191](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.ts#L191) --- -### getConfig +### getConfig ▸ **getConfig**(): `MermaidConfig` @@ -60,11 +60,11 @@ The currentConfig #### Defined in -config.ts:136 +[config.ts:136](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.ts#L136) --- -### getSiteConfig +### getSiteConfig ▸ **getSiteConfig**(): `MermaidConfig` @@ -84,11 +84,11 @@ The siteConfig #### Defined in -config.ts:96 +[config.ts:96](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.ts#L96) --- -### reset +### reset ▸ **reset**(`config?`): `void` @@ -118,11 +118,11 @@ config.ts:96 #### Defined in -config.ts:223 +[config.ts:223](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.ts#L223) --- -### sanitize +### sanitize ▸ **sanitize**(`options`): `void` @@ -147,11 +147,11 @@ options in-place #### Defined in -config.ts:151 +[config.ts:151](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.ts#L151) --- -### saveConfigFromInitialize +### saveConfigFromInitialize ▸ **saveConfigFromInitialize**(`conf`): `void` @@ -167,11 +167,11 @@ config.ts:151 #### Defined in -config.ts:75 +[config.ts:75](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.ts#L75) --- -### setConfig +### setConfig ▸ **setConfig**(`conf`): `MermaidConfig` @@ -199,11 +199,11 @@ The currentConfig merged with the sanitized conf #### Defined in -config.ts:113 +[config.ts:113](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.ts#L113) --- -### setSiteConfig +### setSiteConfig ▸ **setSiteConfig**(`conf`): `MermaidConfig` @@ -232,11 +232,11 @@ The new siteConfig #### Defined in -config.ts:61 +[config.ts:61](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.ts#L61) --- -### updateCurrentConfig +### updateCurrentConfig ▸ **updateCurrentConfig**(`siteCfg`, `_directives`): `MermaidConfig` @@ -253,11 +253,11 @@ config.ts:61 #### Defined in -config.ts:14 +[config.ts:14](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.ts#L14) --- -### updateSiteConfig +### updateSiteConfig ▸ **updateSiteConfig**(`conf`): `MermaidConfig` @@ -273,4 +273,4 @@ config.ts:14 #### Defined in -config.ts:79 +[config.ts:79](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.ts#L79) diff --git a/docs/config/setup/modules/defaultConfig.md b/docs/config/setup/modules/defaultConfig.md index 1ec49b672..e4b34e9bc 100644 --- a/docs/config/setup/modules/defaultConfig.md +++ b/docs/config/setup/modules/defaultConfig.md @@ -8,17 +8,17 @@ ## Variables -### configKeys +### configKeys • `Const` **configKeys**: `string`\[] #### Defined in -defaultConfig.ts:1869 +[defaultConfig.ts:1869](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/defaultConfig.ts#L1869) --- -### default +### default • `Const` **default**: `Partial`<`MermaidConfig`> @@ -53,4 +53,4 @@ A description of each option follows below. #### Defined in -defaultConfig.ts:33 +[defaultConfig.ts:33](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/defaultConfig.ts#L33) diff --git a/docs/config/setup/modules/mermaidAPI.md b/docs/config/setup/modules/mermaidAPI.md index ef5fc5848..1ef1853ed 100644 --- a/docs/config/setup/modules/mermaidAPI.md +++ b/docs/config/setup/modules/mermaidAPI.md @@ -8,13 +8,13 @@ ## References -### default +### default Renames and re-exports [mermaidAPI](mermaidAPI.md#mermaidapi) ## Variables -### mermaidAPI +### mermaidAPI • `Const` **mermaidAPI**: `Readonly`<{ `defaultConfig`: `MermaidConfig` = configApi.defaultConfig; `getConfig`: () => `MermaidConfig` = configApi.getConfig; `getSiteConfig`: () => `MermaidConfig` = configApi.getSiteConfig; `globalReset`: () => `void` ; `initialize`: (`options`: `MermaidConfig`) => `Promise`<`void`> ; `parse`: (`text`: `string`, `parseError?`: `ParseErrorFunction`) => `boolean` ; `parseDirective`: (`p`: `any`, `statement`: `string`, `context`: `string`, `type`: `string`) => `void` ; `render`: (`id`: `string`, `text`: `string`, `cb`: (`svgCode`: `string`, `bindFunctions?`: (`element`: `Element`) => `void`) => `void`, `container?`: `Element`) => `Promise`<`void`> ; `reset`: () => `void` ; `setConfig`: (`conf`: `MermaidConfig`) => `MermaidConfig` = configApi.setConfig; `updateSiteConfig`: (`conf`: `MermaidConfig`) => `MermaidConfig` = configApi.updateSiteConfig }> @@ -80,11 +80,11 @@ mermaid.initialize(config); #### Defined in -mermaidAPI.ts:546 +[mermaidAPI.ts:546](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaidAPI.ts#L546) ## Functions -### decodeEntities +### decodeEntities ▸ **decodeEntities**(`text`): `string` @@ -100,11 +100,11 @@ mermaidAPI.ts:546 #### Defined in -mermaidAPI.ts:72 +[mermaidAPI.ts:72](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaidAPI.ts#L72) --- -### encodeEntities +### encodeEntities ▸ **encodeEntities**(`text`): `string` @@ -120,4 +120,4 @@ mermaidAPI.ts:72 #### Defined in -mermaidAPI.ts:46 +[mermaidAPI.ts:46](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaidAPI.ts#L46) diff --git a/packages/mermaid/package.json b/packages/mermaid/package.json index 2e724d506..848e5a346 100644 --- a/packages/mermaid/package.json +++ b/packages/mermaid/package.json @@ -31,7 +31,7 @@ "build:esbuild": "concurrently \"pnpm build:code\" \"pnpm build:types\"", "build": "pnpm clean; pnpm build:esbuild", "dev": "node .esbuild/serve.cjs", - "docs:code": "typedoc --plugin typedoc-plugin-markdown --readme none --githubPages false --hideBreadcrumbs --gitRemote disable --hideInPageTOC --namedAnchors --out src/docs/config/setup --entryPointStrategy expand src/defaultConfig.ts src/config.ts src/mermaidAPI.ts && prettier --write ./src/docs/config/setup", + "docs:code": "typedoc src/defaultConfig.ts src/config.ts src/mermaidAPI.ts && prettier --write ./src/docs/config/setup", "docs:build": "rimraf ../../docs && pnpm docs:code && ts-node-esm src/docs.mts", "docs:verify": "pnpm docs:code && ts-node-esm src/docs.mts --verify", "docs:pre:vitepress": "rimraf src/vitepress && pnpm docs:code && ts-node-esm src/docs.mts --vitepress", diff --git a/packages/mermaid/typedoc.json b/packages/mermaid/typedoc.json new file mode 100644 index 000000000..0e3b12b91 --- /dev/null +++ b/packages/mermaid/typedoc.json @@ -0,0 +1,11 @@ +{ + "plugin": ["typedoc-plugin-markdown"], + "readme": "none", + "githubPages": false, + "gitRemote": "origin", + "gitRevision": "master", + "out": "src/docs/config/setup", + "entryPointStrategy": "expand", + "hideBreadcrumbs": true, + "hideInPageTOC": true +}