mirror of
https://github.com/mermaid-js/mermaid.git
synced 2025-09-23 09:20:03 +02:00
chore: Configure typedoc source links
This commit is contained in:
@@ -8,17 +8,17 @@
|
|||||||
|
|
||||||
## Variables
|
## Variables
|
||||||
|
|
||||||
### <a id="defaultconfig" name="defaultconfig"></a> defaultConfig
|
### defaultConfig
|
||||||
|
|
||||||
• `Const` **defaultConfig**: `MermaidConfig`
|
• `Const` **defaultConfig**: `MermaidConfig`
|
||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
config.ts:7
|
[config.ts:7](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.ts#L7)
|
||||||
|
|
||||||
## Functions
|
## Functions
|
||||||
|
|
||||||
### <a id="adddirective" name="adddirective"></a> addDirective
|
### addDirective
|
||||||
|
|
||||||
▸ **addDirective**(`directive`): `void`
|
▸ **addDirective**(`directive`): `void`
|
||||||
|
|
||||||
@@ -36,11 +36,11 @@ Pushes in a directive to the configuration
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
config.ts:191
|
[config.ts:191](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.ts#L191)
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### <a id="getconfig" name="getconfig"></a> getConfig
|
### getConfig
|
||||||
|
|
||||||
▸ **getConfig**(): `MermaidConfig`
|
▸ **getConfig**(): `MermaidConfig`
|
||||||
|
|
||||||
@@ -60,11 +60,11 @@ The currentConfig
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
config.ts:136
|
[config.ts:136](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.ts#L136)
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### <a id="getsiteconfig" name="getsiteconfig"></a> getSiteConfig
|
### getSiteConfig
|
||||||
|
|
||||||
▸ **getSiteConfig**(): `MermaidConfig`
|
▸ **getSiteConfig**(): `MermaidConfig`
|
||||||
|
|
||||||
@@ -84,11 +84,11 @@ The siteConfig
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
config.ts:96
|
[config.ts:96](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.ts#L96)
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### <a id="reset" name="reset"></a> reset
|
### reset
|
||||||
|
|
||||||
▸ **reset**(`config?`): `void`
|
▸ **reset**(`config?`): `void`
|
||||||
|
|
||||||
@@ -118,11 +118,11 @@ config.ts:96
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
config.ts:223
|
[config.ts:223](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.ts#L223)
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### <a id="sanitize" name="sanitize"></a> sanitize
|
### sanitize
|
||||||
|
|
||||||
▸ **sanitize**(`options`): `void`
|
▸ **sanitize**(`options`): `void`
|
||||||
|
|
||||||
@@ -147,11 +147,11 @@ options in-place
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
config.ts:151
|
[config.ts:151](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.ts#L151)
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### <a id="saveconfigfrominitialize" name="saveconfigfrominitialize"></a> saveConfigFromInitialize
|
### saveConfigFromInitialize
|
||||||
|
|
||||||
▸ **saveConfigFromInitialize**(`conf`): `void`
|
▸ **saveConfigFromInitialize**(`conf`): `void`
|
||||||
|
|
||||||
@@ -167,11 +167,11 @@ config.ts:151
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
config.ts:75
|
[config.ts:75](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.ts#L75)
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### <a id="setconfig" name="setconfig"></a> setConfig
|
### setConfig
|
||||||
|
|
||||||
▸ **setConfig**(`conf`): `MermaidConfig`
|
▸ **setConfig**(`conf`): `MermaidConfig`
|
||||||
|
|
||||||
@@ -199,11 +199,11 @@ The currentConfig merged with the sanitized conf
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
config.ts:113
|
[config.ts:113](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.ts#L113)
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### <a id="setsiteconfig" name="setsiteconfig"></a> setSiteConfig
|
### setSiteConfig
|
||||||
|
|
||||||
▸ **setSiteConfig**(`conf`): `MermaidConfig`
|
▸ **setSiteConfig**(`conf`): `MermaidConfig`
|
||||||
|
|
||||||
@@ -232,11 +232,11 @@ The new siteConfig
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
config.ts:61
|
[config.ts:61](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.ts#L61)
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### <a id="updatecurrentconfig" name="updatecurrentconfig"></a> updateCurrentConfig
|
### updateCurrentConfig
|
||||||
|
|
||||||
▸ **updateCurrentConfig**(`siteCfg`, `_directives`): `MermaidConfig`
|
▸ **updateCurrentConfig**(`siteCfg`, `_directives`): `MermaidConfig`
|
||||||
|
|
||||||
@@ -253,11 +253,11 @@ config.ts:61
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
config.ts:14
|
[config.ts:14](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.ts#L14)
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### <a id="updatesiteconfig" name="updatesiteconfig"></a> updateSiteConfig
|
### updateSiteConfig
|
||||||
|
|
||||||
▸ **updateSiteConfig**(`conf`): `MermaidConfig`
|
▸ **updateSiteConfig**(`conf`): `MermaidConfig`
|
||||||
|
|
||||||
@@ -273,4 +273,4 @@ config.ts:14
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
config.ts:79
|
[config.ts:79](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.ts#L79)
|
||||||
|
@@ -8,17 +8,17 @@
|
|||||||
|
|
||||||
## Variables
|
## Variables
|
||||||
|
|
||||||
### <a id="configkeys" name="configkeys"></a> configKeys
|
### configKeys
|
||||||
|
|
||||||
• `Const` **configKeys**: `string`\[]
|
• `Const` **configKeys**: `string`\[]
|
||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
defaultConfig.ts:1869
|
[defaultConfig.ts:1869](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/defaultConfig.ts#L1869)
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### <a id="default" name="default"></a> default
|
### default
|
||||||
|
|
||||||
• `Const` **default**: `Partial`<`MermaidConfig`>
|
• `Const` **default**: `Partial`<`MermaidConfig`>
|
||||||
|
|
||||||
@@ -53,4 +53,4 @@ A description of each option follows below.
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
defaultConfig.ts:33
|
[defaultConfig.ts:33](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/defaultConfig.ts#L33)
|
||||||
|
@@ -8,13 +8,13 @@
|
|||||||
|
|
||||||
## References
|
## References
|
||||||
|
|
||||||
### <a id="default" name="default"></a> default
|
### default
|
||||||
|
|
||||||
Renames and re-exports [mermaidAPI](mermaidAPI.md#mermaidapi)
|
Renames and re-exports [mermaidAPI](mermaidAPI.md#mermaidapi)
|
||||||
|
|
||||||
## Variables
|
## Variables
|
||||||
|
|
||||||
### <a id="mermaidapi" name="mermaidapi"></a> 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 }>
|
• `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
|
#### Defined in
|
||||||
|
|
||||||
mermaidAPI.ts:546
|
[mermaidAPI.ts:546](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaidAPI.ts#L546)
|
||||||
|
|
||||||
## Functions
|
## Functions
|
||||||
|
|
||||||
### <a id="decodeentities" name="decodeentities"></a> decodeEntities
|
### decodeEntities
|
||||||
|
|
||||||
▸ **decodeEntities**(`text`): `string`
|
▸ **decodeEntities**(`text`): `string`
|
||||||
|
|
||||||
@@ -100,11 +100,11 @@ mermaidAPI.ts:546
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
mermaidAPI.ts:72
|
[mermaidAPI.ts:72](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaidAPI.ts#L72)
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### <a id="encodeentities" name="encodeentities"></a> encodeEntities
|
### encodeEntities
|
||||||
|
|
||||||
▸ **encodeEntities**(`text`): `string`
|
▸ **encodeEntities**(`text`): `string`
|
||||||
|
|
||||||
@@ -120,4 +120,4 @@ mermaidAPI.ts:72
|
|||||||
|
|
||||||
#### Defined in
|
#### Defined in
|
||||||
|
|
||||||
mermaidAPI.ts:46
|
[mermaidAPI.ts:46](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaidAPI.ts#L46)
|
||||||
|
@@ -31,7 +31,7 @@
|
|||||||
"build:esbuild": "concurrently \"pnpm build:code\" \"pnpm build:types\"",
|
"build:esbuild": "concurrently \"pnpm build:code\" \"pnpm build:types\"",
|
||||||
"build": "pnpm clean; pnpm build:esbuild",
|
"build": "pnpm clean; pnpm build:esbuild",
|
||||||
"dev": "node .esbuild/serve.cjs",
|
"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: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: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",
|
"docs:pre:vitepress": "rimraf src/vitepress && pnpm docs:code && ts-node-esm src/docs.mts --vitepress",
|
||||||
|
11
packages/mermaid/typedoc.json
Normal file
11
packages/mermaid/typedoc.json
Normal file
@@ -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
|
||||||
|
}
|
Reference in New Issue
Block a user