Update docs

This commit is contained in:
Nikolay Rozhkov
2023-06-25 01:18:38 +03:00
parent 6a893a758b
commit 2a22bae1f9
6 changed files with 33 additions and 31 deletions

View File

@@ -16,4 +16,4 @@
#### Defined in #### Defined in
[mermaidAPI.ts:77](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaidAPI.ts#L77) mermaidAPI.ts:77

View File

@@ -39,7 +39,7 @@ bindFunctions?.(div); // To call bindFunctions only if it's present.
#### Defined in #### Defined in
[mermaidAPI.ts:97](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaidAPI.ts#L97) mermaidAPI.ts:97
--- ---
@@ -51,4 +51,4 @@ The svg code for the rendered graph.
#### Defined in #### Defined in
[mermaidAPI.ts:87](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaidAPI.ts#L87) mermaidAPI.ts:87

View File

@@ -14,7 +14,7 @@
#### Defined in #### Defined in
[config.ts:7](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.ts#L7) config.ts:7
## Functions ## Functions
@@ -36,7 +36,7 @@ Pushes in a directive to the configuration
#### Defined in #### Defined in
[config.ts:191](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.ts#L191) config.ts:191
--- ---
@@ -60,7 +60,7 @@ The currentConfig
#### Defined in #### Defined in
[config.ts:137](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.ts#L137) config.ts:137
--- ---
@@ -84,7 +84,7 @@ The siteConfig
#### Defined in #### Defined in
[config.ts:96](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.ts#L96) config.ts:96
--- ---
@@ -118,7 +118,7 @@ The siteConfig
#### Defined in #### Defined in
[config.ts:223](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.ts#L223) config.ts:223
--- ---
@@ -147,7 +147,7 @@ options in-place
#### Defined in #### Defined in
[config.ts:152](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.ts#L152) config.ts:152
--- ---
@@ -167,7 +167,7 @@ options in-place
#### Defined in #### Defined in
[config.ts:75](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.ts#L75) config.ts:75
--- ---
@@ -199,7 +199,7 @@ The currentConfig merged with the sanitized conf
#### Defined in #### Defined in
[config.ts:113](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.ts#L113) config.ts:113
--- ---
@@ -232,7 +232,7 @@ The new siteConfig
#### Defined in #### Defined in
[config.ts:61](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.ts#L61) config.ts:61
--- ---
@@ -253,7 +253,7 @@ The new siteConfig
#### Defined in #### Defined in
[config.ts:14](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.ts#L14) config.ts:14
--- ---
@@ -273,4 +273,4 @@ The new siteConfig
#### Defined in #### Defined in
[config.ts:79](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.ts#L79) config.ts:79

View File

@@ -14,7 +14,7 @@
#### Defined in #### Defined in
[defaultConfig.ts:2293](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/defaultConfig.ts#L2293) defaultConfig.ts:2298
--- ---
@@ -53,4 +53,4 @@ A description of each option follows below.
#### Defined in #### Defined in
[defaultConfig.ts:33](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/defaultConfig.ts#L33) defaultConfig.ts:33

View File

@@ -25,7 +25,7 @@ Renames and re-exports [mermaidAPI](mermaidAPI.md#mermaidapi)
#### Defined in #### Defined in
[mermaidAPI.ts:81](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaidAPI.ts#L81) mermaidAPI.ts:81
## Variables ## Variables
@@ -96,7 +96,7 @@ mermaid.initialize(config);
#### Defined in #### Defined in
[mermaidAPI.ts:663](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaidAPI.ts#L663) mermaidAPI.ts:663
## Functions ## Functions
@@ -127,7 +127,7 @@ Return the last node appended
#### Defined in #### Defined in
[mermaidAPI.ts:308](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaidAPI.ts#L308) mermaidAPI.ts:308
--- ---
@@ -153,7 +153,7 @@ the cleaned up svgCode
#### Defined in #### Defined in
[mermaidAPI.ts:256](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaidAPI.ts#L256) mermaidAPI.ts:256
--- ---
@@ -179,7 +179,7 @@ the string with all the user styles
#### Defined in #### Defined in
[mermaidAPI.ts:185](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaidAPI.ts#L185) mermaidAPI.ts:185
--- ---
@@ -202,7 +202,7 @@ the string with all the user styles
#### Defined in #### Defined in
[mermaidAPI.ts:233](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaidAPI.ts#L233) mermaidAPI.ts:233
--- ---
@@ -229,7 +229,7 @@ with an enclosing block that has each of the cssClasses followed by !important;
#### Defined in #### Defined in
[mermaidAPI.ts:169](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaidAPI.ts#L169) mermaidAPI.ts:169
--- ---
@@ -249,7 +249,7 @@ with an enclosing block that has each of the cssClasses followed by !important;
#### Defined in #### Defined in
[mermaidAPI.ts:155](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaidAPI.ts#L155) mermaidAPI.ts:155
--- ---
@@ -269,7 +269,7 @@ with an enclosing block that has each of the cssClasses followed by !important;
#### Defined in #### Defined in
[mermaidAPI.ts:126](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaidAPI.ts#L126) mermaidAPI.ts:126
--- ---
@@ -295,7 +295,7 @@ Put the svgCode into an iFrame. Return the iFrame code
#### Defined in #### Defined in
[mermaidAPI.ts:287](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaidAPI.ts#L287) mermaidAPI.ts:287
--- ---
@@ -320,4 +320,4 @@ Remove any existing elements from the given document
#### Defined in #### Defined in
[mermaidAPI.ts:358](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaidAPI.ts#L358) mermaidAPI.ts:358

10
run
View File

@@ -1,16 +1,14 @@
#!/bin/bash #!/bin/bash
RUN="docker-compose run --rm" RUN="docker-compose run --rm"
# UP="docker-compose up"
name=$(basename $0) name=$(basename $0)
command=$1 command=$1
args=${@:2} args=${@:2}
case $command in case $command in
sh) sh)
$RUN mermaid sh $args $RUN mermaid sh -c "npx $args"
;; ;;
i | install) i | install)
@@ -35,7 +33,10 @@ $RUN mermaid sh -c "npx pnpm -w run lint:fix $args"
dev) dev)
$RUN --service-ports mermaid sh -c "npx pnpm run dev" $RUN --service-ports mermaid sh -c "npx pnpm run dev"
# $UP --rm mermaid sh -c "npx pnpm run dev" ;;
docs:dev)
$RUN --service-ports mermaid sh -c "npx pnpm --filter mermaid run docs:dev"
;; ;;
help) help)
@@ -45,6 +46,7 @@ Run commonly used commands within docker containers
\033[1m$name install\033[0m # Equvalent of pnpm install \033[1m$name install\033[0m # Equvalent of pnpm install
\033[1m$name dev\033[0m # Run dev server with examples, open http://localhost:9000 \033[1m$name dev\033[0m # Run dev server with examples, open http://localhost:9000
\033[1m$name docs:dev\033[0m # For docs contributions, open http://localhost:3333
$name add # Add package, 'run add d3-sankey' $name add # Add package, 'run add d3-sankey'
$name prettier # Prettify a file 'run prettier <path-to-file>' $name prettier # Prettify a file 'run prettier <path-to-file>'