c17dc15c57
chore: Rename to teamMembers
2023-07-06 15:54:27 +05:30
2b5da79cdf
Merge pull request #4112 from aloisklink/add-jsonschema-schema-for-config
...
Use JSON Schema to define and document `MermaidConfig`
2023-07-06 10:03:55 +00:00
aaec16ed6c
chore: Remove lint warnings in example-diagram
2023-07-06 11:58:55 +05:30
d2e62022f1
Avoid downloading avtars everytime on docs:dev
2023-07-06 11:09:09 +05:30
29291c8901
Merge branch 'develop' into pr/aloisklink/4112
...
* develop:
test: test partial QuadrantChartConfig options
test: fix types in `config.spec.ts`
style: fix lint issues in src/config.spec.ts
test: rename src/config.spec.js to config.spec.ts
fix lint
update homepage community link
docs(flowchart): add documentation on multiple nodes style
Add docker-specific command, leave commonly used command intact
Support docs:dev in docker
Fix lint.
Update docs
add ChatGPT plugin blog post
Fix flowchart tooltip typing
2023-07-06 10:42:13 +05:30
1a4e5d9c5a
Merge pull request #4562 from lishid/patch-3
...
Fix flowchart tooltip typing bug
2023-07-06 04:19:08 +00:00
e80e281a66
Merge pull request #4600 from tomperr/docs/4558-multiple-vertices-with-style
...
docs(flowchart): add documentation on multiple nodes style
2023-07-06 04:10:43 +00:00
04597d29c0
Merge pull request #4599 from nirname/fix/support-docs-dev-in-docker
...
Support docs:dev in docker
2023-07-06 04:04:18 +00:00
43df84a4d5
Merge branch 'master' into develop
...
* master:
fix lint
update homepage community link
Update docs
add ChatGPT plugin blog post
2023-07-06 09:34:26 +05:30
a753b1f18b
Merge branch 'develop' into fix/support-docs-dev-in-docker
2023-07-06 09:29:51 +05:30
c29088af01
build(docs): fix links to `config.schema.json`
...
Fix the link in some Mermaid Config markdown documentation,
which previously pointed to `src/schemas/config.schema.yaml`,
which went nowhere.
Now, these links point to:
- config.schema.json (i.e. the generated JSON file, not YAML)
- links are relative to the markdown documentation
We also needed to store the `schema.json` file in the Vitepress
`public/` folder, as Vitepress otherwise doesn't bundle `.json` files
properly, when running `vitepress build src/vitepress`.
2023-07-06 03:53:40 +01:00
70a5a13273
docs: add link to mermaid config docs in sidebar
2023-07-06 03:53:40 +01:00
063cb124cd
test(config): add temp test for defaultConfig
...
Adds a temporary test to ensure that the new defaultConfig,
generated by Vite automatically from the `MermaidConfig` JSON Schema,
has the same values as the old defaultConfig
(taken from
38013de711/packages/mermaid/src/defaultConfig.ts
2023-07-06 03:53:40 +01:00
eb5d65fabc
build(types): create types from config JSON Schema
...
Runs `pnpm --filter mermaid run types:build-config` to automatically
generate typescript types for `MermaidConfig` from the
JSON Schema file.
2023-07-06 03:53:40 +01:00
7c3a73d4a8
build(types): add script to generate Config types
...
Add script `packages/mermaid/scripts/create-types-from-json-schema.mts`
to automatically generate the TypeScript definition for `MermaidConfig`
from the `MermaidConfig` JSON Schema at
`packages/mermaid/src/schemas/config.schema.yaml`.
To do this, we are using this library
[`json-schema-to-typescript`][1], which is also used by Webpack to
generate their types from their JSON Schema.
In order to make sure that this isn't a breaking change, the script
makes all fields **optional**, as that is what the original typescript
file has.
Additionally, I've put in some custom logic into the script, so that
the exact same order is used for the TypeScript file, to make the
`git diff` easier to review. In the future, we can remove this custom
logic, once we no longer need to worry about `git merge` conflicts.
[1]: https://github.com/bcherny/json-schema-to-typescript
2023-07-06 03:53:40 +01:00
0230722d36
build(docs): build JSON Schema docs
...
Automatically build documentation for JSON Schema.
This is only built when running with `--vitepress`,
as it currently produces loads of markdown files, which I feel like
we shouldn't be committing.
This currently manually uses some internal `jsonschema2md` functions
so that we can manually control the Markdown output.
2023-07-06 03:53:40 +01:00
52a1243da5
build: use vite to get default mermaid config
...
Adds a vitepress JsonSchema plugin that automatically loads
the Mermaid Config JSON Schema from a .schema.yaml file and
gets the default values from it.
2023-07-06 03:53:40 +01:00
58b43976ff
feat: add Mermaid Config in JSON Schema format
...
Add a JSON Schema file (in YAML) for the MermaidConfig.
This JSON Schema file follows [JSON Schema 2019-09][1], with some slight
modifications to work with:
- [json-schema-to-typescript][2]
The `tsType` keyword is used to override the generated TypeScript
type, when it doesn't match the JSON Schema type.
This is used in two cases:
- when the current type cannot be represented in JSON Schema
(e.g. `FontCalculator`, which is a function)
- when the JSON Schema type is narrower than the TypeScript type.
Currently, many enums types are listed as `string` in TypeScript,
but json-schema-to-typescript converts them to `"val1" | "val2"`.
I've manually set them to `string | "val1" | "val2"` to avoid
causing a breaking change in the TypeScript types. We should
remove these in a future major version of TypeScript.
- [@adobe/jsonschema2md][3]
The `meta:enum` keyword is used to add documentation for specific enum
values.
[1]: https://json-schema.org/draft/2019-09/release-notes.html
[2]: https://www.npmjs.com/package/json-schema-to-typescript
[3]: https://www.npmjs.com/package/@adobe/jsonschema2md
2023-07-06 03:53:35 +01:00
4372a54dba
docs: add support for ```regexp``` code blocks
...
Currently, shiki doesn't support code-blocks that use the regexp
language, which means vitepress throws an error on them:
```regexp
^([1-9][0-9]*)(minute|hour|day|week|month)$
```
As a hack until shiki supports them, I've just modified them to get
converted into JavaScript RegEx literal code-blocks, e.g.:
```javascript
/^([1-9][0-9]*)(minute|hour|day|week|month)$/
```
2023-07-06 03:04:08 +01:00
a862565a24
test: test partial QuadrantChartConfig options
2023-07-06 01:35:11 +01:00
6ceee7f253
test: fix types in `config.spec.ts`
...
The `foo`, `bar`, and `foobar` options don't exist in MermaidConfig.
Instead, I've replaced them with:
- `foo` -> `fontFamily`
- `bar` -> `fontSize`
- `foobar` -> `altfontFamily`
2023-07-06 01:27:24 +01:00
f731853e01
style: fix lint issues in src/config.spec.ts
...
It looks like our linter automatically converts `let` to `const` in
TypeScript files, but not in JavaScript files.
2023-07-06 01:20:24 +01:00
5885f5f82a
test: rename src/config.spec.js to config.spec.ts
2023-07-06 01:19:34 +01:00
38013de711
fix(quadrant): make quadrant options optional
...
Make the types of the options in QuadrantChartConfig in the
MermaidConfig optional. All of these (except for the values in
`BaseDiagramConfig`) will be automatically set to their
default values, so they're optional from a user perspective.
2023-07-06 01:06:01 +01:00
9251e520ab
fix lint
2023-07-05 13:50:33 -07:00
5e7e3e21c8
update homepage community link
2023-07-05 13:42:42 -07:00
fcb25aee7c
docs(flowchart): add documentation on multiple nodes style
2023-07-05 21:09:44 +02:00
95d62367e9
Add docker-specific command, leave commonly used command intact
2023-07-05 19:39:05 +03:00
1d5f3bb64d
Merge branch 'develop' into enhancement/4158_Add_primary_key_beginning_with_asterisk
2023-07-05 11:19:08 -04:00
bd772e1bf4
Merge branch 'develop' into bug/4590_allow_notes_identical_to_keywords
2023-07-05 11:00:00 -04:00
34b2b5ba35
Support docs:dev in docker
2023-07-05 17:25:07 +03:00
c742ac71a4
Merge pull request #4598 from mermaid-js/sidv/fixDocsDev
...
Fix docs:dev
2023-07-05 14:05:27 +00:00
86e1bb38ee
#3358 First commit with basic grammar and 1st test
2023-07-05 12:01:37 +02:00
382026ed33
Fix docs:dev
2023-07-05 12:20:56 +05:30
34e89098f5
Refactor code smells in unit tests
2023-07-04 21:34:14 -03:00
e3c90ac084
Apply formatting to file
2023-07-04 21:16:14 -03:00
099f85f014
Add unit tests with keywords in notes
2023-07-04 21:07:46 -03:00
49747b314d
Modify wildcard state of tokens in lexer
2023-07-04 20:44:22 -03:00
9f5f0a6e66
Reduce sankey width
2023-07-05 01:49:58 +03:00
8449a44607
Sankey: Remove duplicated examples
2023-07-05 01:15:22 +03:00
12fe6ff26e
Fix lint.
2023-07-03 18:56:00 -07:00
451b6b687e
Merge branch 'develop' into enhancement/4158_Add_primary_key_beginning_with_asterisk
2023-07-03 19:54:26 -04:00
5a94256e4f
Allow entity diagram attribute names to start with asterisk
2023-07-03 15:11:02 -03:00
d5021cab1d
Remove double parsing
2023-07-03 18:57:26 +03:00
1b190b2892
Merge pull request #4551 from Yokozuna59/refactor-accessibility
...
refactor accessibility
2023-07-03 15:07:21 +00:00
6d7cd2b41f
Merge pull request #4580 from aloisklink/refactor/replace-enums
...
Remove all TypeScript enums and forbid them in ESLint
2023-07-03 07:26:39 +00:00
d6731a07db
Update all patch dependencies
2023-07-03 05:18:01 +00:00
fbf79ffcc0
refactor: replace TypeScript enum with JS obj
...
[`const` assertions where added in TypeScript 3.4][1] and can be used
to create enum-like objects in plain JavaScript, that act like
TypeScript enums, but has none of the downsides of TypeScript enums.
[1]: https://devblogs.microsoft.com/typescript/announcing-typescript-3-4/#const-assertions
2023-07-02 23:56:42 +01:00
b989ff5362
fix: change sankey config types to be unions
...
Replace the TypeScript `enum {a = "a", b = "b"}` types with
TypeScript's literal types (e.g. `"a" | "b"`).
This is because TypeScript enums are
[_not_ a type-level addition to JavaScript][1], and even the official
TypeScript docs say to be careful when using.
[1]: https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#enums
2023-07-02 23:44:19 +01:00
592e9c959b
fix(diagrams/c4/parser): fixes support of the macro ContainerQueue_Ext for C4 diagrams.
2023-07-02 17:10:06 +02:00
406df57f81
Merge branch 'develop' into refactor-accessibility
2023-07-02 10:24:21 +02:00
dfc466514d
Merge branch 'develop' into feature/1838_actor_creation_destruction
2023-07-02 13:36:04 +05:30
2a1759aab4
Merge branch 'develop' into refactor-accessibility
2023-07-02 13:04:09 +05:30
b55a9328f4
Update all patch dependencies
2023-07-02 05:07:56 +00:00
19325777e5
Merge branch 'develop' into feature/1838_actor_creation_destruction
2023-07-02 10:32:59 +05:30
afb979f32b
Merge branch 'develop' into feature/4492_sankey-diagrams
2023-07-02 09:55:45 +05:30
abb7bb23d6
More detailed sankey docs
2023-07-02 02:34:22 +03:00
084b765e9f
Added tests for colors and fully setup cypress in Docker
2023-07-02 01:10:06 +03:00
4570f824f7
Fix relative link to theme variables list
2023-07-01 15:45:48 -03:00
a62719826a
Docker+Cypress, better run, removed unused syntax
...
Added cypress container (from their official image),
may be reconsidered later to choose our own
The only minor problem is node JS version mistmatch
package.json 18.16.0
docker-compose mermaid 18.16.1
docker-compose cypress 18.16.0
Host option in cypress docker container must be removed
in favor of possible configuration option.
http://localhost:9000 are currently hard-coded, that is bad
Updated ./run script with better documentation
and added some styles too it as well
Started sankey.spec.js as an example
2023-07-01 16:17:25 +03:00
cd7fce4e4d
Merge branch 'develop' into feature/4492_sankey-diagrams
2023-06-30 22:58:56 +03:00
1645bf0479
Merge branch 'develop' into pr/Valentine14th/4466
...
* develop:
Add threshold
Updated mermaid version to 10.2.4
update latest news section
2023-07-01 00:29:43 +05:30
4217bfc15d
Merge branch 'develop' into update-latest-news-section
...
* develop:
Add threshold
Fix Typo
2023-07-01 00:29:06 +05:30
efa3ba6397
add ChatGPT plugin blog post
2023-06-30 11:08:42 -07:00
02d4be23cf
Merge remote-tracking branch 'origin/develop' into develop
2023-06-30 13:25:32 +02:00
04b11d1ba6
Merge branch 'release/10.2.4'
2023-06-30 13:24:43 +02:00
453b337e6e
Updated mermaid version to 10.2.4
2023-06-30 13:10:22 +02:00
3fe0c8b13d
Merge branch 'develop' into feature/1838_actor_creation_destruction
2023-06-30 16:00:24 +05:30
a1dfc3dac9
Fix Typo
2023-06-30 11:59:40 +02:00
0cab66c9d8
Fix flowchart tooltip typing
...
Tooltip is an object that gets reset to an array. It is then looked up for properties without guard, causing array functions like "length" and "constructor" to run into undefined behvaior.
2023-06-29 15:33:35 -04:00
b2f6858ff7
Prettier
2023-06-29 20:23:10 +03:00
06cb0c3be9
Fixed package json
2023-06-29 20:22:06 +03:00
9177350a39
Fixed double quotes, docs, demo and added more examples to run script
2023-06-29 20:16:25 +03:00
e24dce10a2
Added sankey documentation
2023-06-29 19:51:46 +03:00
e7ad294283
Merge branch 'develop' into feature/4492_sankey-diagrams
2023-06-29 16:50:38 +03:00
95a436595e
Let it be as it was in dev branch
2023-06-29 16:44:33 +03:00
8e3f8b1a57
Fixes after review
2023-06-29 15:39:50 +03:00
408c32781e
Contributors fetching failure must not hinder docs development
2023-06-29 15:24:14 +03:00
a712e61888
Loading avatars in parallel & started sankey documentation
2023-06-29 15:24:14 +03:00
562910e831
Merge pull request #4532 from tomperr/fix/4519-namespace-lose-members
...
fix(class): keep members in namespace classes
2023-06-29 11:57:22 +05:30
47db1a3c9f
Cleanup
2023-06-29 10:36:21 +05:30
491f8c1259
Clean up some spacing in examples
2023-06-28 15:14:28 -07:00
83bda9febd
Correct the Gantt milestones example
2023-06-28 14:37:08 -07:00
6aae7450aa
Merge pull request #4557 from nienow/patch-1
...
Add Standard Notes extension in integrations page
2023-06-28 13:05:22 +05:30
c042c4a5ef
Merge pull request #4553 from tomperr/fix/4550-chaining-style
...
fix(flowchart): allow multiple vertices with style
2023-06-28 13:02:55 +05:30
777f6d9749
Add Standard Notes extension in integrations page
2023-06-27 21:28:36 -05:00
191309a79d
run lint:fix
2023-06-28 03:34:28 +03:00
9e024fd5f5
allow multiple vertices with style
2023-06-27 20:04:47 +02:00
226960ef46
refactor mermaidAPI accessibilities
2023-06-27 20:07:50 +03:00
228bafa909
refactor accessibility
...
- remove @ts-ignore comments
- rename vitest test and describe title
- remove unnecessary types, e.i, `null` and `number`
- clean `addSVGa11yTitleDescription` and `setA11yDiagramInfo` functions
2023-06-27 20:04:41 +03:00
8b111760b1
Updates after review
2023-06-27 17:50:51 +03:00
d9db2edf5a
Merge pull request #4539 from ellenealds/patch-1
...
Update Tutorials.md
2023-06-27 19:16:31 +05:30
e1c9aec775
Merge remote-tracking branch 'nirname/develop' into feature/4492_sankey-diagrams
2023-06-27 16:25:18 +03:00
f0231ad9b1
Lint
2023-06-27 16:22:12 +03:00
0bbf0555d3
Fix linters
2023-06-27 16:17:55 +03:00
d4d7ce5a4b
Fixed majority of ts errors for sankey
2023-06-27 16:12:44 +03:00
bbba643288
Rmoved unnecessary imports in tests
2023-06-27 15:30:53 +03:00
830319e3db
Removed unnecessary TODO
2023-06-27 15:21:36 +03:00
32c8524317
Put d3-sankey under mermaid package
2023-06-27 15:15:34 +03:00
616c5e6914
Move UID to separate file, refine run sh
2023-06-27 15:05:25 +03:00
f27015fcf8
Merge pull request #4547 from mermaid-js/renovate/major-workbox-monorepo
...
chore(deps): update dependency workbox-window to v7
2023-06-27 17:23:44 +05:30
d2ff3a63e8
Merge pull request #4524 from mcbeelen/docs/label-color-timelines
...
docs: Howto on foreground color on timelines
2023-06-27 17:23:24 +05:30
605e8d4a92
Sankey refactoring
2023-06-27 14:11:06 +03:00
e2f21a2d98
Lint fix
2023-06-27 13:03:31 +02:00
f606ad2d9d
docs: Howto on foreground color on timelines
2023-06-27 11:23:54 +02:00
1730a229a5
chore(deps): update dependency workbox-window to v7
2023-06-27 09:21:55 +00:00
f48652322d
chore(deps): update dependency jsdom to v22
2023-06-27 07:13:43 +00:00
2bec82707f
Merge pull request #4528 from Yokozuna59/bug/4527_fix-optional-style-issue
...
fix not rendered style when style is optional
2023-06-27 11:30:15 +05:30
5a96bd1b9f
fix(flowchart): apply style on doublecircle
2023-06-27 00:22:59 +02:00
64a28be5e3
rename `getDiagramStyles` type into `DiagramStylesProvider`
2023-06-26 20:34:21 +03:00
8b67200717
change `options` paramter to any instead of `unknown`
2023-06-26 19:31:53 +03:00
3106ddbd1e
add `getDiagramStyles` type and use it in `style.ts`
2023-06-26 19:28:22 +03:00
f020f4a292
remove `diagramTheme` arrow function return
...
Co-authored-by: Sidharth Vinod <sidharthv96@gmail.com>
2023-06-26 19:12:04 +03:00
c439424511
Merge branch 'mermaid-js:develop' into bug/4527_fix-optional-style-issue
2023-06-26 19:06:08 +03:00
2fe5750be1
Merge pull request #4531 from Yokozuna59/fix-cspell-issue-in-md-files
...
fix cspell issues in *.md files
2023-06-26 21:32:44 +05:30
b0825ebb35
Import at the top
2023-06-26 18:37:41 +03:00
20eb28e1a4
fix cspell issues in *.md files
2023-06-26 18:21:09 +03:00
f2c40271b2
change `diagramTheme` and `themes` to return `string`
2023-06-26 18:06:48 +03:00
f90a7dc784
fix(deps): update all patch dependencies
2023-06-26 03:12:45 +00:00
a38733346f
Removed unnecessary configs and extra code
2023-06-25 21:56:14 +03:00
61e5dbeaa6
fix(class): keep members in namespace classes
2023-06-25 00:15:35 +02:00
6a893a758b
Styles are optional
2023-06-25 01:07:11 +03:00
1d6074dbfa
Sankey: Use [] instead of Array
2023-06-25 00:42:12 +03:00
b23e86aea3
Added options for coloring
2023-06-25 00:22:36 +03:00
1674f12b62
Renamed sankey to sankey-beta
2023-06-24 23:11:54 +03:00
07f6358a80
fix not rendered style when style is optional
2023-06-24 22:18:00 +03:00
2f281ba228
Improvements for sankey diagram after review
2023-06-24 22:02:18 +03:00
b117265fcb
Update Tutorials.md
...
Added tutorial and application demo for AI generated Mermaid Mind Map
2023-06-23 19:08:13 +01:00
d766ac6d20
Prettier
2023-06-22 23:50:11 +03:00
7ace602a6c
Fixed linters
2023-06-22 23:24:41 +03:00
c75c106490
Put styles back
2023-06-22 23:02:13 +03:00
d9036c7af1
Added gradient for sankey and cleaned code
2023-06-22 21:26:39 +03:00
518da3236f
Remove unnecessary parsing stage from render and prepare text before parsing
2023-06-22 18:28:02 +03:00
104aece46e
Cleanup sankey diagrams according code review
2023-06-22 17:35:46 +03:00
9a29066426
Ensure that sankey keyword does not intefere with csv
2023-06-22 16:53:44 +03:00
be9cd480aa
Sankey syntax has beed reduced
2023-06-22 15:58:09 +03:00
272615e580
Fixed tests and added node alignment
2023-06-21 03:54:55 +03:00
bc33c8210c
Merge branch 'develop' into feature/4492_sankey-diagrams
2023-06-21 03:00:27 +03:00
7bc5c1930e
Fix specs
2023-06-21 02:58:25 +03:00
24d9f59d69
Fix specs
2023-06-21 02:52:21 +03:00
6c6efb24f4
Fix graph width
2023-06-21 01:58:57 +03:00
362648b74b
Trim trailing spaces
2023-06-21 01:37:06 +03:00
a2c055ba5d
CSV syntax implementation
2023-06-21 01:29:34 +03:00
6077ba5405
Updated syntax and fixed comments from review
2023-06-20 03:06:47 +03:00
53eada8028
Fix typo in quadrant chart documentation
2023-06-19 21:33:40 +02:00
14582fb13d
fix(deps): update all patch dependencies
2023-06-19 04:53:17 +00:00
1009bb8fb7
Prettify
2023-06-19 04:29:41 +03:00
6722ac7540
Multiple improvements on syntax
...
Syntax has been simplified
Removed extra initial states
Removed unused groups
Nodes can be wrapped in double qotes
Updated demo page
2023-06-19 04:02:40 +03:00
9dbb9872bc
Fix linters
2023-06-19 01:05:33 +03:00
19f858b73b
Fixed nodes duplicates
2023-06-19 01:05:33 +03:00
Sidharth Vinod